newfol

No description

Find a file

Benson Chu dfdd1bbb34 I think this is packaged correctly		2025-04-26 19:16:13 -05:00
doc	doc: allow specifying parameters for xsltproc.	2015-01-16 22:58:26 +00:00
newfol	I think this is packaged correctly	2025-04-26 19:16:13 -05:00
test	Add tests for pluggable hooks.	2015-01-22 15:15:32 +00:00
utils	Move utilities to their own directory.	2013-10-12 18:30:05 +00:00
.gitignore	Update Makefile to build AsciiDoc documentation.	2014-03-19 22:28:00 +00:00
COPYING	License code under GPLv2 with peter's permission.	2011-09-08 15:26:33 -05:00
Makefile	Makefile: enhance clean rule.	2014-11-18 02:23:58 +00:00
README.adoc	README: update dependencies for docs and development.	2015-01-19 02:43:15 +00:00
setup.py	I think this is packaged correctly	2025-04-26 19:16:13 -05:00
shell.nix	I think this is packaged correctly	2025-04-26 19:16:13 -05:00

README.adoc

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.