From 33c093678f9dc9e997385770b1877c871947e9d1 Mon Sep 17 00:00:00 2001 From: Jaromil Date: Mon, 17 Jul 2017 14:13:47 +0200 Subject: instructions and build target in makefile --- Makefile | 8 ++++++-- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 46 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 942de72..5c4161d 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,5 @@ BUILD=go build - SOURCES=scorsh.go \ types.go \ config.go \ @@ -10,8 +9,13 @@ workers.go all: scorsh +deps: + go get 'github.com/fsnotify/fsnotify' + go get 'github.com/libgit2/git2go' + go get 'github.com/go-yaml/yaml' + go get 'golang.org/x/crypto/openpgp' -scorsh: $(SOURCES) +scorsh: $(SOURCES) $(BUILD) scorsh.go types.go config.go spooler.go commits.go workers.go clean: 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 +``` -- cgit v1.2.3