From 95b2f2b3cf37ee4a70f791998385c123a0b3d99c Mon Sep 17 00:00:00 2001 From: Luke Smith Date: Sat, 1 Dec 2018 22:37:02 -0500 Subject: [PATCH] better dox --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 51d38aa..fd29529 100644 --- a/README.md +++ b/README.md @@ -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