code review.

[mediawiki_dump_tools.git] / README.rst

diff --git a/README.rst b/README.rst
index 111728ca7ef5e8695c91cab4b8cad17e8eb4e52d..9320fed2019f551988d093c5a4106ae57dfc37ad 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -7,3 +7,13 @@ submodule like::
 
   git submodule init
   git submodule update
 
   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 pandas