Add a README file.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
This commit is contained in:
brian m. carlson 2013-10-12 17:38:32 +00:00
parent dce0800a7d
commit d583df2b38
No known key found for this signature in database
GPG key ID: BF535D811F52F68B

23
README.md Normal file
View file

@ -0,0 +1,23 @@
newfol
======
newfol is a small, custom database and graphical frontend.
Requirements
------------
* Python 3
* [Urwid](http://excess.org/urwid/)
In Debian, installing the `python3-urwid` package will generally satisfy the
dependencies.
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.