diff --git a/README.md b/README.md index 4eff62e..464eede 100644 --- a/README.md +++ b/README.md @@ -3,24 +3,24 @@ There are a lot of ways to manage your dotfiles. dotGit implements an idea that has been floating around on the internet for a while: a bare git repo for storing your dotfiles. A quick search finds [this](https://news.ycombinator.com/item?id=11070797), but there may be older sources. dotGit has modest aims -- ๐Ÿกkeep config files where tools expect them in `$HOME` -- ๐Ÿšstay as light and close to git and the shell as possible -- ๐Ÿš€reduce friction and make config changes quick and convenient +- ๐Ÿก keep config files where tools expect them in `$HOME` +- ๐Ÿš stay as light and close to git and the shell as possible +- ๐Ÿš€ reduce friction and make config changes quick and convenient dotGit gives you a handful of shell aliases (tested with `zsh`๐Ÿš and `bash`) to make dotfile management quick and easy. The shortcuts mimic a subset of those found in the [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) [git](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/git) plugin. - `.g` is the alias for running `git` with correct `--git-dir` and `--work-tree` -- `.ga` to `git add` -- `.gc` to `git commmit` -- `.gco` to `git checkout` -- `.gd` to run `git diff` +- `.ga` runs `git add` +- `.gc` runs `git commmit` +- `.gco` runs `git checkout` +- `.gd` runs `git diff` - `.gss` shows the `git status --short` -- `.gp` will `git push` -- `.gl` witll `git pull` +- `.gp` will `git push` the changes to the origin +- `.gl` will `git pull` changes from the origin - `.glo` runs `git log --oneline --decorate ` - `.glg` runs `git log --stat` - `.glgp` runs `git log --stat --patch` -- `.gg` runs `git grep` on your dotfiles. It will pass it through [FZF](https://github.com/junegunn/fzf) (if available) for editing with `$EDITOR` on the correct line (works with vi, emacs, nano, and micro) +- `.gg` runs `git grep` on your dotfiles. If [FZF](https://github.com/junegunn/fzf) is installed it will be used to present the matches, and make it easy open your `$EDITOR` on the right line (works with vi, emacs, nano, micro, and any editor that accepts the `+` syntax to indicate the line number). - `.ge` (requires [FZF](https://github.com/junegunn/fzf)) lists all files using FZF and opens the selected file in your `$EDITOR` - `.lazygit` (requires [lazygit](https://github.com/jesseduffield/lazygit)) will run `lazygit` with the correct `-g` and `-w` - `.gitui` (requires [gitui](https://github.com/extrawurst/gitui)) will run `gitui` with the correct `-d` and `-w` @@ -40,13 +40,13 @@ There are two additional aliases used to (re)set up the bare git setup. ## installation -1. clone this repository or simply copy the [aliases.sh](./aliases.sh) -2. add some config sauce to your shell initialization (.i.e. `.zshrc` or `.bashrc`). The `DOT_FILES` and `DOT_HOME` variables **must be set** for the aliases.sh to load! +1. clone this repository or simply copy the [dotGit.sh](./dotGit.sh) +2. add some config sauce to your shell initialization (.i.e. `.zshrc` or `.bashrc`). The `DOT_FILES` and `DOT_HOME` variables **must be set** for the dotGit.sh to load! ```bash export DOT_FILES="${HOME}/.dotfiles" export DOT_HOME="${HOME}" export DOT_ORIGIN="git@github.com:user/your-dotfiles-repo.git" # optional - source ` + source ` ``` 3. restart your shell or `source ~/.zshrc` or `source ~/.bashrc` 4. run `.ginit` or `.gclone` (see the *initial clone setup* below, if cloning) diff --git a/aliases.sh b/dotGit.sh similarity index 100% rename from aliases.sh rename to dotGit.sh