diff options
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | README.md | 13 |
2 files changed, 13 insertions, 2 deletions
@@ -2,10 +2,8 @@ UNAME := $(shell uname) ifeq ($(UNAME), Linux) CC=clang --std=gnu99 -CXX=clang --std=gnu++11 else CC=clang --std=c99 -CXX=clang --std=c++11 endif CFLAGS=-Wall -Wextra -Werror -g 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}` |
