eryn/dotfiles
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update the README, which hasn't been updated in literal years

Browse source
This commit is contained in:
Eryn Wells 2022-01-22 10:22:55 -08:00
parent 1c2e9025cf
commit b6146c816b
1 changed files with 18 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,9 +1,9 @@
Dotfiles Dotfiles
======== ========
This is my collection of dotfiles, preserved here for all to see and enjoy. This is my collection of dotfiles, preserved here for all to see and enjoy. Feel
Feel free to copy anything you see here. It would be nice if you added a free to copy anything you see here. It would be nice if you added a comment
comment mentioning where you got it. mentioning where you got it.
My environment relies on `zsh`, `vim`, and `git`. My environment relies on `zsh`, `vim`, and `git`.
@ -12,42 +12,33 @@ My environment relies on `zsh`, `vim`, and `git`.
Clone the repository to a directory on your machine. I like to use Clone the repository to a directory on your machine. I like to use
`~/.dotfiles`. `~/.dotfiles`.
```sh
git clone https://github.com/erynofwales/dotfiles.git ~/.dotfiles git clone https://github.com/erynofwales/dotfiles.git ~/.dotfiles
```
Run the setup script. Run the setup script.
```sh
cd ~/.dotfiles cd ~/.dotfiles
./setup.sh ./setup.sh
```
This script will symlink all the config files in the directory to your home This script will symlink all the config files in the directory to your home
directory, clone a bunch of git repos, and do some other miscellaneous setup. directory, clone a bunch of git repos, and do some other miscellaneous setup.
Enjoy. Enjoy.
## Shell Environment ## Profiling
As much as possible, I tried to keep these files as system agnostic as ZSH has a built in profiler. If you're concerned about init times, place the
possible. I work on lots of different systems so having the ability to bring following at the top of `.zshenv`.
down my core environment and customize it is very useful. Most of the
environment files have three levels:
1. The main file (e.g. `.zshrc`). ```zsh
2. A system specific file whose name is generated by the `uname -s` command. zmodload zsh/zprof
So, these files have names like `.zshrc.darwin` and `.env.linux`. The system ```
name is exported as `$SYS` in the `.env` script.
3. A machine specific file whose name is derived by appending `.local` to the
main file's name (e.g. `.zshrc.local`).
Files 2 and 3 are sourced at the end of the main file, so any settings you add Then, at the end of either `.zshrc` or `.zprofile`, call `zprof` to get the
there will override those set in the main file. results of the profiling session.
## Loud Noises!
In a recent change I added some extra functions to print out status
messages as ZSH starts up. These are all defined in `shell-functions`
(symlinked to `~/.shell-functions` by the setup script). At any point in the
setup process, you can set the variable `$NOISY` to a number greater than 0 to
see extra status messages.
## License ## License