From: groceryheist <nathante@uw.edu>
Date: Wed, 4 Jul 2018 22:20:52 +0000 (-0700)
Subject: add note to readme about dependency on compression software
X-Git-Url: https://code.communitydata.science/mediawiki_dump_tools.git/commitdiff_plain/a883cb536b2af1f2120f26104bfc2c29334924ba?hp=e925ac9da10b20ab4ef949263887a1f9158e805f

add note to readme about dependency on compression software
---

diff --git a/README.rst b/README.rst
index 111728c..8a13bd9 100644
--- a/README.rst
+++ b/README.rst
@@ -7,3 +7,7 @@ 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`.