Better readme

djuretic · Jun 28, 2021 · f7bb90a · f7bb90a
1 parent 9fb8c34
commit f7bb90a
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 *.html
 output/*.opf
 *.txt
+!requirements.txt
 *.mobi
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# Reta Vortaro - Kindle
+
+<img src="screenshot.png" alt="screenshot" height="400px">
+
+This dictionary was built using data from [Reta Vortaro](https://www.reta-vortaro.de).
+
+You'll need Python 3, xlstproc and kindlegen to generate the dictionary.
+
+```bash
+git submodule init && git submodule update
+pip install -r requirements.txt
+./process.sh
+# this will generate the .mobi file
+./kindlegen output/vortaro.opf
+```
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+beautifulsoup4==4.9.3
+soupsieve==2.2.1
diff --git a/screenshot.png b/screenshot.png