aboutsummaryrefslogtreecommitdiff
path: root/apps/koffice/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'apps/koffice/README.md')
-rw-r--r--apps/koffice/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/apps/koffice/README.md b/apps/koffice/README.md
new file mode 100644
index 000000000000..2e37820450a6
--- /dev/null
+++ b/apps/koffice/README.md
@@ -0,0 +1,25 @@
+# k-office
+
+A set of plain-text, free software tools to run a small business.
+
+
+## Set of tools
+
+Currently k-office consists of the following tools. A support library
+`libko` provides the basic building blocks for other tools.
+
+- cassiopeia -- a plain-text time tracking tool
+- invoice -- a LaTeX template based invoice generator
+
+
+## How to build
+
+Build files for the whole suite are provided in [`nix/`](./nix/). You
+can also build individual tools (e.g. to hack on) via Cargo.
+
+
+## Contributions
+
+If you want to make suggestions, or send a patch in you can do so via
+my public inbox. Either send the patches directly, or via a
+request-pull!