summaryrefslogtreecommitdiff
path: root/README.md
blob: 5edb28aec9f6015217fcaaef306c145dca5cdda2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# 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`). If configuration file is already set it will load the current
configuration file for you to edit.

## 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.

## TODO