Skip to content
This repository has been archived by the owner on Feb 10, 2023. It is now read-only.

Commit

Permalink
some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mineo committed Apr 16, 2016
1 parent 9b01d8f commit a8d93be
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
21 changes: 20 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,23 @@
abzer
===============================

* Documentation: https://abzer.rtfd.org
Install abzer as shown `here
<https://abzer.readthedocs.org/en/latest/setup.html>`_, run it by either calling
`/usr/bin/abzer` or `python -m abzer`.

Until Read the Docs supports Python 3.5, I'll just dump `--help` here::

usage: abzer [-h] [-c CONFIG] [-p PROCESSES] [-v] FILENAME [FILENAME ...]

positional arguments:
FILENAME

optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
The path to the config file. (default:
/home/<username>/.abzsubmit/abzsubmit.conf)
-p PROCESSES, --processes PROCESSES
The number of processes to use for analyzing files.
(default: <number of cpus>)
-v, --verbose Be more verbose. (default: False)
5 changes: 1 addition & 4 deletions docs/source/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,4 @@ You can easily clone the code with git::

Now you can start hacking on the code or install it system-wide::

python2 setup.py install

Setup
-----
python setup.py install

0 comments on commit a8d93be

Please sign in to comment.