diff --git a/README.md b/README.md new file mode 100644 index 0000000..3766179 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Sync Kiwix +This is a small script to synchronize kiwix zim files from the official repository + +## Requirements +You will need conda. See https://conda.io/projects/conda/en/latest/user-guide/install/index.html for installation instructions. + +## Install + +Clone this repo: +```bash +git clone https://git.fusselkater.org/fusselkater/sync_kiwix.git +``` + +Change into the sync_kiwix directory and install the conda environment: +```bash +conda env create -f environment.yml +``` + +## Usage +Activate the conda environment: +```bash +conda activate sync_kiwix +``` + +Run the script: +```bash +python ./sync_kiwix.py --help +``` + +The output of `--help` will show you the available commands. + +### Example +To download the archlinux wiki: +```bash +python sync_kiwix.py archlinux_en_all_maxi . +```