diff options
author | Dan Davison <dandavison7@gmail.com> | 2019-06-26 12:07:23 -0400 |
---|---|---|
committer | Dan Davison <dandavison7@gmail.com> | 2019-06-26 12:30:51 -0400 |
commit | 01ce9b3ab437660807e9b6eeadd3d4b47c1071eb (patch) | |
tree | ed82ce2cade98decd123983798134bb916debf5f /README.md | |
parent | 36d1de25e92a5e07bc18f4ec052bf5ca62894ccb (diff) |
README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..a44e4cd9 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +## Δ + A syntax-highlighting pager for git. + + _(This project is at a very early stage, but please feel free to open issues.)_ + +## Installation + +#### 1. Rust development environment. + See https://www.rust-lang.org/tools/install. + +#### 2. Clone this repo. + +#### 3. Build the executable: + ```sh + cd delta + cargo build + ``` + This creates an executable inside the repo at `target/debug/delta`. Copy or symlink this executable to somewhere on your shell + `$PATH`. + + If you're not sure what that means, ignore it, and use + `/path/to/delta/target/debug/delta | less -R` in the next step. + +#### 4. Configure git to use delta: + Edit your `~/.gitconfig`: + ``` + [core] + pager = delta | less -R + ``` + Alternatively, run this command: + ``` + git config --global core.pager 'delta | less -R' + ``` + +All git commands that display diff output should now display syntax-highlighted output. For example: + - `git diff` + - `git show` + - `git log -p` + - `git stash show -p` + +## Credit + https://github.com/trishume/syntect<br> + https://github.com/sharkdp/bat |