newfol/README.adoc
brian m. carlson 944c76d7b1
README: update dependencies for docs and development.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
2015-01-19 02:43:15 +00:00

44 lines
976 B
Text

newfol
======
newfol is a small, custom database and graphical frontend.
Requirements
------------
* Python 3
* http://urwid.org[Urwid]
In Debian, installing the +python3-urwid+ package will generally satisfy the
dependencies.
If you want to build the documentation as well, you'll need
* Asciidoctor
* Apache FOP
* DocBook XSL-NS stylesheets (the DocBook 5 ones)
* xsltproc
Development requirements include
* pep8
* pyflakes3
newfol is generally developed with the latest version of Python 3, but should be
compatible with earlier versions. Please file an issue on GitHub if something
is broken.
Getting newfol
--------------
newfol may be cloned by using git from any number of places:
git clone https://github.com/bk2204/newfol
git clone https://git.crustytoothpaste.net/git/bmc/newfol.git
It can be run immediately out of the same directory. No installation is needed.
License
-------
newfol is licensed under the GNU General Public License, version 2.