Initial commit

cruessler · Oct 1, 2017 · 30ad416 · 30ad416
commit 30ad416
Show file tree

Hide file tree

Showing 5 changed files with 561 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/target/
+**/*.rs.bk
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "git-tree"
+version = "0.1.0"
+authors = ["Christoph Rüßler <[email protected]>"]
+
+[dependencies]
+ansi_term = "0.10.1"
+clap = "2.26.2"
+git2 = "0.6.8"
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# git-tree
+
+git-tree is a small command line utility for showing the status of untracked
+and modified files in a git repository as a tree.
+
+## Installation
+
+Because it uses `#![feature(advanced_slice_patterns, slice_patterns)]`, it
+currently (2017-10) requires a nightly compiler. See
+https://github.com/rust-lang/rust/issues/23121 and
+https://doc.rust-lang.org/1.8.0/book/slice-patterns.html.
+
+Provided you have `cargo` installed, installation is as easy as
+
+```
+cargo install https://github.com/cruessler/git-tree
+```
+
+This will download the source code and compile the binary which can then be
+found in `~/.cargo/bin`. If that’s in your `$PATH`, you can type `git-tree
+--help` to get an overview of the available commands.