Skip to content

Commit

Permalink
little README tweaks
Browse files Browse the repository at this point in the history
- forgot to correctly format an instance of $HOME
- linking a mention of updot to the updot section
  • Loading branch information
ymendel committed Aug 21, 2021
1 parent cdf2dc7 commit 4af8a6a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ understand and handle with this separation.

- **script/**: This is the location for scripts and commands that handle the dotfiles project itself, like `script/bootstrap`
- **bin/**: This gets added to the `$PATH` and anything in here is available to run everywhere. This is a sort of general, catch-all
location for commands and utilities that don't fit elsewhere. Also, `updot` lives here. (see below)
location for commands and utilities that don't fit elsewhere. Also, `updot` lives here. ([see below](#updot))
- _topic_/**bin/**: These directories also get added to the `$PATH`, for topic-related commands that will be made available to run everywhere.
- _topic_/**\*.bash**: Any files ending in `.bash` get loaded into the environment.
- _topic_/**install.sh**: Any file named `install.sh` is executed by `script/install` (which is run by `updot`). These end in `.sh`
instead of `.bash` to avoid being loaded automatically.
- _topic_/**\*.symlink**: Any file ending in `.symlink` gets symlinked into $HOME with a prepended `.` (e.g. `git/gitconfig.symlink``~/.gitconfig`)
- _topic_/**\*.symlink**: Any file ending in `.symlink` gets symlinked into `$HOME` with a prepended `.` (e.g. `git/gitconfig.symlink``~/.gitconfig`)
This lets all of these files stay versioned in the dotfiles repository, but still be useful in their expected locations.
These files are symlinked by `script/bootstrap` (not `updot`).
- **~/.local/bashrc**: This file will be sourced if it exists, allowing you to have special per-machine differences.
Expand Down

0 comments on commit 4af8a6a

Please sign in to comment.