From f2b60f89391fae4ed34d7f25f999062ef35ddeec Mon Sep 17 00:00:00 2001 From: Freddie Date: Mon, 12 Mar 2012 15:59:17 +1030 Subject: [PATCH] Update README to hopefully be a little more understandable --- README.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index b698811..ed72ce9 100644 --- a/README.rst +++ b/README.rst @@ -2,14 +2,17 @@ newsmangler =========== -newsmangler is a basic client for posting to Usenet. The only notable feature is -multiple connection support to efficiently utilize modern bandwidth. +newsmangler is a basic client for posting binaries to Usenet. The only notable +feature is multiple connection support to efficiently utilize modern bandwidth. Installation ============ #. Download the source: ``git clone git://github.com/madcowfred/newsmangler.git`` + (or download a .zip I guess). #. Copy sample.conf to ~/.newsmangler.conf, edit the options as appropriate. + ``cp sample.conf ~/.newsmangler.conf`` + ``nano ~/.newsmangler.conf`` #. Download and install the `yenc module `_ for greatly improved yEnc encoding speed. @@ -17,14 +20,18 @@ Installation Usage ===== Make a directory containing the files you wish to post, the _directory name_ will -be used as the post subject. For example: +be used as the post subject. For example, with a directory structure such as: test post please ignore/ + - test.nfo - test.part1.rar - test.part2.rar -Will post as: - ``test post please ignore [1/2] - "test.part1.rar" yEnc (01/27)`` - ``test post please ignore [2/2] - "test.part2.rar" yEnc (01/27)`` +And the command line: ``python mangler.py "test post please ignore"`` -Run ``python mangler.py --help`` for other options. +The files will post as: + ``test post please ignore [1/3] - "test.nfo" yEnc (1/1)`` + ``test post please ignore [2/3] - "test.part1.rar" yEnc (01/27)`` + ``test post please ignore [3/3] - "test.part2.rar" yEnc (01/27)`` + +See ``python mangler.py --help`` for other options.