added readme

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f589120
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Org to conky parser
+This is a small C project meant to parse and organize the contents of my EMACS org todolist, in order to display it on my desktop with Conky.
+
+## Getting started
+To get a copy of the project, clone the repository. 
+To compile it, a simple `make` should do just fine.
+
+## Prerequisites
+This project is set to compile using `clang`, if you want to change that, go into the `Makefile` and edit the `CC` line.
+
+## Use with Conky
+- Compile the project
+- Add the following line to your conky config: `${exec /path/to/otc /path/to/todolist.org}`