X-Git-Url: https://code.communitydata.science/mediawiki_dump_tools.git/blobdiff_plain/108c8442b211065606f81f3facbde23d3377ec6c..2ff4d6061399c22eb539f1fd609e7046aa44dba9:/README.rst diff --git a/README.rst b/README.rst index 111728c..94802bd 100644 --- a/README.rst +++ b/README.rst @@ -7,3 +7,13 @@ submodule like:: git submodule init git submodule update + + +Wikimedia dumps are usually in a compressed format such as 7z (most common), +gz, or bz2. Wikiq uses your computer's compression software to read these +files. Therefore wikiq depends on `7za`, `gzcat`, and `zcat`. + +There are also a series of Python dependencies. You can install these using pip +with a command like: + + pip3 install mwbase mwreverts mwxml mwtypes mwcli mwdiffs mwpersistence