diff --git a/README.org b/README.org new file mode 100644 index 0000000..67b0ada --- /dev/null +++ b/README.org @@ -0,0 +1,15 @@ +#+title: Inbox Size + +A simple script that counts the number of headings in my inbox file for display in a status bar like [[https://polybar.github.io/][Polybar]]. + +* Requirements + +This script needs [[https://scsh.net/][scsh]] and [[https://www.gnu.org/software/emacs/][Emacs]]. + +* Installation + +Put the =inbox-size= script anywhere in your =$PATH=. + +* Usage + +Run the =inbox-size= script without arguments. This script assumes that your inbox file is located in =$HOME/documents/gtd/inbox.org=.