better dox

This commit is contained in:
Luke Smith 2018-12-01 22:37:02 -05:00
parent 139bae724a
commit 95b2f2b3cf

View file

@ -18,21 +18,16 @@ There are my dotfiles! The name of the repo, "voidrice", came from the fact they
## More documentation ## More documentation
I've added very thorough documentation of this whole system to `.readme.mom`. There's a full .pdf write-up of the repository [here: https://larbs.xyz/larbs_readme.pdf](https://larbs.xyz/larbs_readme.pdf).
Compile it to be read with the following command:
``` Or, if you actually installed my dotfiles, you can just press `Super+F1` to
groff -mom .readme.mom -Tpdf > larbs_readme.pdf show the same document offline.
```
Or, if you actually installed my dotfiles, you can just press `Super+F1`. The
reason this document is written in groff rather than markdown is so it can be
compiled realtime on the system, avoiding me pushing bloated .pdfs to this repo
everytime there's a need for documentation additions.
In the system, you can also press `Super+Shift+e` to watch tutorial videos on In the system, you can also press `Super+Shift+e` to watch tutorial videos on
different programs used. See [my YouTube channel](https://youtube.com/c/LukeSmithxyz) for more. different programs used. See [my YouTube channel](https://youtube.com/c/LukeSmithxyz) for more.
The command `getkeys` will also show basic key binds for different programs.
## Dynamic Configuration Files ## Dynamic Configuration Files
Store your favorite or high-traffic directories in `~/.bmdirs` or your most Store your favorite or high-traffic directories in `~/.bmdirs` or your most