From ab3949db502c82bf7714c05501d94f9b655e5c81 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan-Marten=20Br=C3=BCggemann?= <fussel@fusselkater.org>
Date: Sat, 14 Sep 2024 01:28:48 +0200
Subject: [PATCH] add readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.md

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 .
+```