NapoleonDynamite/voidrice
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

better dox

Browse source
This commit is contained in:
Luke Smith 2018-12-01 22:37:02 -05:00
parent 139bae724a
commit 95b2f2b3cf
1 changed files with 5 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -18,21 +18,16 @@ There are my dotfiles! The name of the repo, "voidrice", came from the fact they
## More documentation
I've added very thorough documentation of this whole system to `.readme.mom`.
Compile it to be read with the following command:
There's a full .pdf write-up of the repository [here: https://larbs.xyz/larbs_readme.pdf](https://larbs.xyz/larbs_readme.pdf).
```
groff -mom .readme.mom -Tpdf > larbs_readme.pdf
```
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.
Or, if you actually installed my dotfiles, you can just press `Super+F1` to
show the same document offline.
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.
The command `getkeys` will also show basic key binds for different programs.
## Dynamic Configuration Files
Store your favorite or high-traffic directories in `~/.bmdirs` or your most