add CONTRIBUTING file

xxyzz · Nov 9, 2020 · 1f2eabe · 1f2eabe
1 parent b2e58a6
commit 1f2eabe
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1,32 @@
+# Contributing
+
+## Documents
+
+- https://manual.calibre-ebook.com
+
+- https://docs.python.org/3
+
+- https://github.com/kovidgoyal/calibre
+
+- https://wiki.mobileread.com/wiki/E-book_formats
+
+## Debug
+
+```
+$ calibre-customize -b .
+$ calibre-debug -g
+```
+
+## Build
+
+```
+$ zip -r worddumb-version *
+```
+
+## Add more words
+
+Get `cn-kll.en.en.klld` and `LanguageLayer.en.ASIN.kll` from your Kindle device, then:
+
+```
+$ create_ww_sql.py ./path-of-klld ./path-of-kll
+```