Skip to content
Browse files

Added README.

  • Loading branch information...
1 parent 7782034 commit 7950dce09f43be8cb6c6421a4a0df6ac39b3a6fa @bboe committed May 28, 2012
Showing with 27 additions and 0 deletions.
  1. +27 −0 README.md
View
27 README.md
@@ -0,0 +1,27 @@
+# torrent_checker
+
+## Installation
+
+First download
+([tar.gz](https://github.com/bboe/torrent_checker/tarball/master),
+[zip](https://github.com/bboe/torrent_checker/zipball/master)) and extract or
+clone (`git clone https://github.com/bboe/torrent_checker.git`) this
+repository.
+
+Then install via:
+
+ python setup.py install
+
+## Running the program
+
+After installation you should have access to `torrent_checker` on your path.
+Simply run via:
+
+ torrent_checker torrent_dir seed_dir
+
+Where `torrent_dir` is a directory that contains torrent files and `seed_dir`
+is a directory that contains the files you've downloaded. After torrent_checker
+runs `torrent_dir` will have two new subdirectories, `failed` and
+`success`. The `failed` subdirectory will contain all torrent files whose
+contents either could not be found or could not be 100% verified and `success`
+contains the remainder.

0 comments on commit 7950dce

Please sign in to comment.
Something went wrong with that request. Please try again.