Add README.md

2020-06-26 22:43:06 +08:00 · 2020-06-26 22:43:06 +08:00 · 2a96c8d61a
commit 2a96c8d61a
parent 70d91723b2
1 changed files with 37 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,37 @@
+# epub_convert
+Online Version: https://epub.stoneapp.tech/
+
+## Requirements
+- Python 3.6 or newer
+
+## Libraries
+- Flask >= 0.13.0
+- OpenCC
+- TocasUI
+- axios
+
+## Usage
+- command line
+```bash
+$ python convert.py <epub>
+```
+
+- development web server
+```bash
+$ python web.py
+```
+
+- apache `mod_wsgi`
+```apache
+<VirtualHost *:80>
+    ServerName domain.name
+
+    WSGIDaemonProcess appname user=user1 group=group1 threads=5
+    WSGIScriptAlias / /location/to/folder/web.wsgi
+    Alias /static /location/to/folder/static
+
+    <Directory "/location/to/folder">
+        Require all granted
+    </Directory>
+</VirtualHost>
+```