From 871cfdeab66f046e9a2e7db8f8b836393d6764f7 Mon Sep 17 00:00:00 2001 From: nanos Date: Tue, 28 Mar 2023 09:34:56 +0100 Subject: [PATCH] Added a note re .pyw and Windows as suggested in #27 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0211545..3c9e214 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ FediFetcher will store posts it has already pulled in, as well as profiles it ha **Be aware, that this script may run for a *very* long time.** This is particularly true, the first time this script runs, and/or if you enable all parts of this script. You should ensure that you take steps to prevent multiple overlapping executions of this script, as that will lead to unpleasant results. +For detailed information on the how and why, please read the [FediFetcher for Mastodon page](https://blog.thms.uk/fedifetcher?utm_source=github). + ## Setup You can run FediFetcher either as a GitHub Action, as a scheduled cron job on your local machine/server, or from a pre-packed container. @@ -61,6 +63,8 @@ When using a cronjob, we are using file based locking to avoid multiple overlapp If you are running FediFetcher locally, my recommendation is to run it manually once, before turning on the cron job: The first run will be significantly slower than subsequent runs, and that will help you prevent overlapping during that first run. +*Note:* if you wish to run FediFetcher using Windows Task Scheduler, you can rename the script to the `.pyw` extension instead of `.py`, and it will run silently, without opening a console window. + ### 2.3) Run FediFetcher from a container FediFetcher is also available in a pre-packaged container, [FediFetcher](https://github.com/nanos/FediFetcher/pkgs/container/fedifetcher) - Thank you [@nikdoof](https://github.com/nikdoof).