summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKatolaZ <katolaz@yahoo.it>2017-07-18 08:16:03 +0100
committerGitHub <noreply@github.com>2017-07-18 08:16:03 +0100
commit8153e16bcdb69fb1a5dc617a783a2b5ddebc78da (patch)
tree999a79082b788b1ffc84039cf0cbd1ac2b0bf617 /README.md
parent74f8a74ecf8284fd4182cabab797f17bb18e7032 (diff)
parent33c093678f9dc9e997385770b1877c871947e9d1 (diff)
Merge pull request #1 from jaromil/build-docs
instructions and build target in makefile
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 40 insertions, 1 deletions
diff --git a/README.md b/README.md
index 748680d..5bac28b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# scorsh
+
Signed-Commit Remote Shell
@@ -9,7 +10,7 @@ signed git commits.
**This is still work-in-progress, not ready to be used yet**
-# WTF
+## WTF
...if you have ever felt that git hooks fall too short to your standards...
@@ -53,3 +54,41 @@ just URLs, at the moment restricted to two possible types:
e.g., Jenkins or Travis builds...)
+
+
+## Build notes
+
+**scorsh** depends from the availability of a native build of
+`libgit2` version `0.25` or greater on the native system where
+***scorsh** is built. This dependencies is easily satisfied on various
+operating systems by using their respective package manager. For
+instance in Devuan ASCII one can simply do:
+
+```
+sudo apt install libgit2-dev
+```
+
+In Devuan Jessie unfortunately `libgit2` is older than `0.25` so one
+should first build `git2go` from its repository, in which `libgit2` is a
+submodule to be built from scratch.
+
+```
+git clone https://github.com/libgit2/git2go
+cd git2go
+git submodule init
+git submodule update
+cd libgit2
+cmake .
+make
+sudo make install
+```
+
+Then proceed installing dependencies for **scorsh**:
+```
+make deps
+```
+
+And finally build its binary:
+```
+make
+```