diff --git a/README.md b/README.md index 54a0739..ed3d624 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ # cl-todo -A simple TODO app for the GNOME desktop. +A simple TODO list widget for the GNOME desktop. Honestly, this was mostly written to give me a chance to try out Gtk+3 on Common Lisp (see this [tutorial](https://lisp-journey.gitlab.io/blog/gui-programming-in-common-lisp-part-3-of-5-gtk3/)). -## Installing +## Usage + +Simply click on `cl-todo`. The app is designed to be used via keyboard shortcuts: + +* UP/DOWN: switch between active widgets + +* ENTER: Complete and remove the active task, or (if the input field is + active) add a new task + +* ESCAPE: Close the window (every action is autosaved) + +Your TODO list is saved under `~/.todo`. + +**Tip:** Add a custom keyboard shortcut to quickly call up your TODO list. To do +so, copy the executable `cl-todo` to `/usr/local/bin` or similar. Then (if +you're in the GNOME shell) go to "Settings" -> "Keyboard shortcuts" and scroll +to the `+` sign at the bottom. Enter `cl-todo` as the command to be executed +and a key combination of your choice (I use `Super`+`Return`). + +## Compiling Requires a Common Lisp (tested on SBCL), [Quicklisp](https://www.quicklisp.org/beta/#installation), and the `cl-cffi-gtk` library. @@ -18,27 +37,15 @@ ln -s /path/to/cl-todo ~/.quicklisp/local-projects/cl-todo ``` -Then, you can open up a REPL and use `(ql:quickload "cl-todo") to run. +Then, you can open up a REPL and use `(ql:quickload :cl-todo)` to run. +To produce a stand-alone executable, run `(asdf:make :cl-todo)`. -## Usage - -`cl-todo` is designed to be used via keyboard shortcuts: - -* UP/DOWN: switch between active widgets - -* ENTER: Complete and remove the active task, or (if the input field is - active) add a new task - -* ESCAPE: Close the window (every action is autosaved) - -## TODO - -* finish basic implementation +## Project TODO * add task priorities -* implement directory-specific todo files (with Nautilus plugin?) +* implement directory-specific todo files (with Nautilus plugin) --- -© *Daniel Vedder, 2020* +*© Daniel Vedder 2020* diff --git a/README.md b/README.md index 54a0739..ed3d624 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ # cl-todo -A simple TODO app for the GNOME desktop. +A simple TODO list widget for the GNOME desktop. Honestly, this was mostly written to give me a chance to try out Gtk+3 on Common Lisp (see this [tutorial](https://lisp-journey.gitlab.io/blog/gui-programming-in-common-lisp-part-3-of-5-gtk3/)). -## Installing +## Usage + +Simply click on `cl-todo`. The app is designed to be used via keyboard shortcuts: + +* UP/DOWN: switch between active widgets + +* ENTER: Complete and remove the active task, or (if the input field is + active) add a new task + +* ESCAPE: Close the window (every action is autosaved) + +Your TODO list is saved under `~/.todo`. + +**Tip:** Add a custom keyboard shortcut to quickly call up your TODO list. To do +so, copy the executable `cl-todo` to `/usr/local/bin` or similar. Then (if +you're in the GNOME shell) go to "Settings" -> "Keyboard shortcuts" and scroll +to the `+` sign at the bottom. Enter `cl-todo` as the command to be executed +and a key combination of your choice (I use `Super`+`Return`). + +## Compiling Requires a Common Lisp (tested on SBCL), [Quicklisp](https://www.quicklisp.org/beta/#installation), and the `cl-cffi-gtk` library. @@ -18,27 +37,15 @@ ln -s /path/to/cl-todo ~/.quicklisp/local-projects/cl-todo ``` -Then, you can open up a REPL and use `(ql:quickload "cl-todo") to run. +Then, you can open up a REPL and use `(ql:quickload :cl-todo)` to run. +To produce a stand-alone executable, run `(asdf:make :cl-todo)`. -## Usage - -`cl-todo` is designed to be used via keyboard shortcuts: - -* UP/DOWN: switch between active widgets - -* ENTER: Complete and remove the active task, or (if the input field is - active) add a new task - -* ESCAPE: Close the window (every action is autosaved) - -## TODO - -* finish basic implementation +## Project TODO * add task priorities -* implement directory-specific todo files (with Nautilus plugin?) +* implement directory-specific todo files (with Nautilus plugin) --- -© *Daniel Vedder, 2020* +*© Daniel Vedder 2020* diff --git a/cl-todo b/cl-todo new file mode 100644 index 0000000..45d0bed --- /dev/null +++ b/cl-todo Binary files differ