kiwix/zimit
1
0
Fork 0
mirror of https://github.com/openzim/zimit.git synced 2025-09-22 11:22:23 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update the readme with better installation instructions

Browse Source
This commit is contained in:
Alexis Métaireau 2016-06-17 18:32:39 +02:00
parent 6756b2e55d
commit a45f56f23a
No known key found for this signature in database
GPG Key ID: 1EDF5A7A485D4A11
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -8,22 +8,29 @@ Given any WebSite, get a ZIM file out of it!
How to use it?
##############
Install it using pip
Install it by checking the sources from github.
::
$ pip install zimit
$ git clone https://github.com/almet/zimit.git
$ cd zimit
Create a virtual environment and install the project in it::
$ virtualenv venv
$ venv/bin/pip install -e .
Then, run it how you want, for instance with pserve::
$ pserve zimit.ini
$ venv/bin/pserve zimit.ini
In a separate process, you also need to run the worker::
$ rqworker
$ venv/bin/rqworker
To test it::
And you're ready to go. To test it::
$ http POST http://0.0.0.0:6543/website url="https://refugeeinfo.eu/" title="Refugee Info" email="alexis@notmyidea.org"
@ -69,11 +76,6 @@ available in /home/www, so let's consider this will be the case here::
$ cd /home/www/zimit.notmyidea.org
$ git clone https://github.com/almet/zimit.git
Create a virtual environment and activate it::
$ virtualenv venv
$ activate venv/bin/activate
Then, you can change the configuration file, by creating a new one::
$ cd zimit