From e4e42a3f2dc72cb88b2882968bc0e43ef8bed07f Mon Sep 17 00:00:00 2001 From: Vladimir Panteleev Date: Thu, 29 Aug 2013 22:16:19 +0000 Subject: [PATCH] Add README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a2f57f --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +wp2git +====== + +This program allows you to download and convert any Wikipedia article's history to a git repository, for easy browsing and blaming. + +### Usage + + $ wp2git Article_name_here + +`wp2git` will create a directory, in which a new git repository will be created. + +Run `wp2git --help` for more options. + +### Requirements + +The commands `git` and `curl` should be accessible from `PATH`. + +### Building + +You will need a [D compiler](http://dlang.org/download.html) to build `wp2git`. + + $ git clone --recursive https://github.com/CyberShadow/wp2git + $ rdmd --build-only wp2git