Add a simple README
This commit is contained in:
parent
bfcd5e48aa
commit
7203d2f103
1 changed files with 15 additions and 0 deletions
15
README.org
Normal file
15
README.org
Normal file
|
@ -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=.
|
Loading…
Reference in a new issue