suzanne.soy/wiki.gruntnetwork.com--zimmer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: Installation

Browse Source
This commit is contained in:
Vadim Shlyakhov 2017-02-20 12:01:18 +03:00 committed by GitHub
parent f066010a47
commit 3df59f713d
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -3,3 +3,11 @@
This is a nodejs [ZIM](http://www.openzim.org/wiki/OpenZIM) file creator -- mostly a drop-in replacement for [zimwriterfs](https://github.com/wikimedia/openzim/tree/master/zimwriterfs).
A notable exception: it does't support *withFullTextIndex* option.
## Installation
* Clone *zimmer* from Github or download ZIP
* Install dependencies: `npm install`
* Symlink *zimmer* as *zimwriterfs*: `ln -s zimmer.js <some directory in $PATH>/zimwriterfs`
* Make sure genuine *zimwriterfs* is not in the $PATH
MWoffliner should pick zimmer up instead of zimwriterfs when it creates ZIM file.