Add git module README
This commit is contained in:
parent
d411be708e
commit
8741bbac24
1 changed files with 30 additions and 0 deletions
30
git/README.md
Normal file
30
git/README.md
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
# Git module
|
||||||
|
|
||||||
|
[git](https://git-scm.com/) - a distributed version control system
|
||||||
|
|
||||||
|
## What's in this module
|
||||||
|
|
||||||
|
[[_TOC_]]
|
||||||
|
|
||||||
|
## Global git settings
|
||||||
|
|
||||||
|
This is probably the first thing that needs to be customized, since it points to a different identity for each git user.
|
||||||
|
|
||||||
|
## Basic git command aliases
|
||||||
|
|
||||||
|
This module contains a heap of aliases to every-day git commands.
|
||||||
|
Most of them follow a two-to-three letter combination of things to do which corresponds to the mnemonic of the longer git command.
|
||||||
|
As such, they are mostly similar to those found in the Oh My Zsh [git plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/git)
|
||||||
|
Examples of some common aliases are `alias ga=git add`, `alias gst=git status`, `alias gp=git push`, `alias gl=git pull`.
|
||||||
|
|
||||||
|
## Gitignore generation script
|
||||||
|
|
||||||
|
Adds a `gitignore` script which pulls relevant .gitignore lines from [gitignore.io](https://www.gitignore.io) and sends them to standard out, or creates a .gitignore file in the current directory.
|
||||||
|
|
||||||
|
[![asciicast](https://asciinema.org/a/298616.svg)](https://asciinema.org/a/298616)
|
||||||
|
|
||||||
|
To show usage of the script run `gitignore -h`. It is fully equipped with zsh auto completions, which will pull a list of all available ignore modules from the website to complete with.
|
||||||
|
|
||||||
|
It can alternatively be run through git itself by invoking `git ignore`, which will always generate a .gitignore file in the current directory.
|
||||||
|
|
||||||
|
When fzf is installed invoke the script without any arguments to generate a fzf-searchable list of git definitions to create. Select multiple definitions with <tab>.
|
Loading…
Reference in a new issue