From 29421ecbb48450bf22e33bdcf57ee1de7412b0be Mon Sep 17 00:00:00 2001 From: Ekaitz Zarraga Date: Sun, 19 Jul 2020 22:52:08 +0200 Subject: first commit --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..b6d0525 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Fracture + +Fracture is an invoice registering system based on the command line. + +It makes a heavy use of `EDITOR` environment variable that lets you edit +invoices based on python's `ConfigParser` module that are later written in a +SQLite database. + +## Configuration + +Run `fracture configure` for configuration. It will automatically open a sample +configuration file for you. Once it's filled it will store the configuration +file in `$XDG_CONFIG_HOME/fracture/config` (`XDG_CONFIG_HOME` falls back to +`$HOME/.config`). + +## Storage + +Storage is done in the configuration directory (for the moment). + +If you want to create a new invoice run `fracture new` and it will open an +empty invoice in your `EDITOR` of choice. Fill it, save and it will create and +store the invoice in the database. -- cgit v1.2.3