Skip to content

Commit

Permalink
Update README to hopefully be a little more understandable
Browse files Browse the repository at this point in the history
  • Loading branch information
madcowfred committed Mar 12, 2012
1 parent 771a6b7 commit f2b60f8
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.rst
Expand Up @@ -2,29 +2,36 @@
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 <https://bitbucket.org/dual75/yenc>`_
for greatly improved yEnc encoding speed.

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.

0 comments on commit f2b60f8

Please sign in to comment.