X-Git-Url: https://git.danieliu.xyz/?p=taskasaur.git;a=blobdiff_plain;f=README.md;h=36e7a342f4912449e0c8a4344348ed7e4f2be7cc;hp=9f4deb70f62d4f8a3dfeaa0e4301c911cd03ff6f;hb=HEAD;hpb=29d7c7040e75ed3da1fa86c429887d5d97e7f80d diff --git a/README.md b/README.md index 9f4deb7..36e7a34 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,15 @@ A very simple kanban style todolist with vim keybindings. -Boards are stored in markdown files. +This project is practically a clone of [taskell](https://github.com/smallhadroncollider/taskell), but written in c, since the haskell dependencies that were pulled in were a bit too heavy for my liking. + +Taskasaur is also meant to be extended with patches, allowing the main project to remain slim. Simply edit the config.h file to your liking and recompile. + +## Installation + +To build from source, simply clone the repo and run +``` +make && sudo make clean install +``` + +A gentoo ebuild with savedconfig use may or may not be coming in the future.