diff --git a/README.md b/README.md new file mode 100644 index 0000000..995e5cc --- /dev/null +++ b/README.md @@ -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.