Changeset 358f734e0b18…
Parent 05535bbaab81…
by Benjamin Pollack <benjamin@fogcreek.com>
Changes to one file · Browse files at 358f734e0b18 Showing diff from parent 05535bbaab81 Diff from another changeset...
|
@@ -1,0 +1,29 @@ + # Overview
+
+**gitkiln** provides a command line tool that provides some integration
+between your local Git repositories and Kiln. It can take you directly
+to Kiln pages corresponding to history, annotations, repository
+settings, and more.
+
+# Installation
+
+If you have downloaded the appropriate binary for your system, simply
+place it somewhere convenient (e.g., on your path), and you can invoke
+it in your preferred manner. We suggest adding an appropriate alias
+to Git so that gitkiln appears to be a normal Git command. For
+example, if you want `git kiln` to invoke `gitkiln`, you would run
+
+ git config --global alias.kiln '!/path/to/gitkiln $@'
+
+from a command line.
+
+If you are building from source, then you can simply do
+
+ go install developers.kilnhg.com/Code/Kiln/Group/gitkiln
+
+and git-kiln will be installed in your `GOPATH`.
+
+# Usage
+
+The full usage of **gitkiln** is documented by built-in help. To see
+it, simply run `gitkiln help`.
|
Loading...