wrynegade/dotwryn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Wryn Wagner 2021-09-15 02:04:21 -06:00
parent 6dc7d247e4
commit 9a2508af4d
1 changed files with 19 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,27 +1,27 @@
# The `.wryn` Library
A compilation of utilities which I use across my machines.
This library represents my lifelong efforts to create a custom, streamlined IDE based on the terminal and terminal-based editors.
So I suppose here is the disclaimer: **this repo is principally for personal utility**.
A compilation of utilities which I use across my machines **this repo is principally for personal utility**.
Although I try to build utilities to be dependency aware, the library is considered to be in a good state when it works on my machine.
Feel free to use or adapt anything you find useful :)
## File Structure Breakdown
### [bin](./bin)
Program-specific shell utilities used throughout configurations and other `zsh` scripts.
These utilities are not used directly by the user and are **not** sourced to the user RC.
### [setup](./setup)
The pride and joy of this project.
Running the script will set up the appropriate links and RC entries to enable the entire library.
Relatively robust, but always works best the OS I'm currently using (arch).
### [config](./config)
Configuration files which are typically symlinked to the `~/.config` directory.
Configuration files / utilities.
The setup script handles all the headache of symlinking each one to the right place.
### [env](./env)
Default environment variables used by library utilities.
Overrides can be set on each machine by editing the appropriate local environment in `~/.config/wryn/`.
Default configuration used by the rest of the library.
You can override the environment by editing `~/.config/wryn/env` files after running setup.
### [freeze](./freeze)
A historical list of packages used on personal machines.
Also contains machine-specific `systemd` daemons for managing hardware-specific issues.
### [resume](./resume)
My working resume in `.tex` format.
### [latex](./latex)
A compilation of LaTeX templates, used by the [`.wryn/zsh/latex`](./zsh/latex) utility.
@ -31,19 +31,16 @@ The `template.tex` file is the parent of the document, and thus the target of th
This can be renamed to match the document title, but typically does not contain the document body.
Every template will use the same parent `template.tex` file, so this is found at the `~/.wryn/latex` directory root.
### [resume](./resume)
My working resume in `.tex` format.
### [vim](./vim)
Contains keybindings, dictionary binary, and custom plugins for `vim`.
The [`setup`](./setup) utility will source the `.wryn/vim/rc.vim` and set up all necessary environment variables.
Local environment overrides are placed in `~/.config/wryn/env/env.vim`.
### [zsh](./zsh)
Contains `zsh` aliases and functions used directly by a terminal user.
Contains (a mess of) `zsh` aliases and functions used directly by a terminal user.
The [`.wryn/zsh/rc`](./zsh/rc), which loads the custom `zsh` modules is sourced directly from the user RC.
Any OS specific utilities are nested in appropriately named directories.
...this will be hacked to pieces very soon
The [`setup`](./setup) utility will source the `.wryn/zsh/rc` and set up all necessary environment variables.
Local environment overrides are placed in `~/.config/wryn/env/env`.
### [freeze](./freeze)
A historical list of packages used on personal machines.
Also contains machine-specific `systemd` daemons for managing hardware-specific issues.
...this will likely move to a cloud storage soon.