Merge pull request #1 from Natim/improve-readme

Improve the ZIMIT README.
This commit is contained in:
Alexis Metaireau 2016-01-10 12:13:50 +01:00
commit 3548e32f60
2 changed files with 38 additions and 1 deletions

View File

@ -1,3 +1,4 @@
#####################################
Create ZIM files out of HTTP websites
#####################################
@ -16,6 +17,7 @@ Then, run it how you want, for instance with pserve::
$ pserve zimit.ini
In a separate process, you also need to run the worker::
$ rqworker
@ -25,3 +27,38 @@ To test it::
$ http POST http://0.0.0.0:6543/website url="https://refugeeinfo.eu/" title="Refugee Info" email="alexis@notmyidea.org"
Ubuntu dependencies
###################
You will need to install the following packages:
- zimwriterfs
- httrack
Installing the dependencies
===========================
::
sudo apt-get install httrack libzim-dev libmagic-dev liblzma-dev libz-dev build-essential
Installing zimwriterfs
======================
::
git clone https://github.com/wikimedia/openzim.git
cd openzim/zimwriterfs
./autogen.sh
./configure
make
Then upgrade the path to zimwriterfs executable in zimit.ini
::
$ rqworker & pserve zimit.ini
That's it!

View File

@ -8,7 +8,7 @@ pyramid.debug_routematch = false
pyramid.debug_templates = true
pyramid.default_locale_name = en
zimit.zimwriterfs_bin = /home/alexis/dev/openzim/zimwriterfs/zimwriterfs
zimit.zimwriterfs_bin = /home/rhubscher/git/openzim/zimwriterfs/zimwriterfs
zimit.httrack_bin = /usr/bin/httrack
[server:main]