added README file to document the submodule

[mediawiki_dump_tools.git] / README.rst

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..111728c
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,9 @@
+When you install this from git, you will need to first clone the repository::
+
+  git clone git://projects.mako.cc/mediawiki_dump_tools
+
+From within the repository working directory, initiatlize and set up the
+submodule like::
+
+  git submodule init
+  git submodule update