From 55a269f1072cf97f8402026b0e077959ab7a02ab Mon Sep 17 00:00:00 2001 From: Daniel <dhaavi@users.noreply.github.com> Date: Mon, 13 Jan 2020 11:46:46 +0100 Subject: [PATCH] Add docs for building process --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6d35854..0b3a48e 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,19 @@ Jess does not have a PKI or some sort of web of trust. You have to exchange publ Jess is also capable of securing a network connection, but this currently only works with the library, not the CLI. +### Building + +Jess uses [dep](https://github.com/golang/dep) as the dependency manager. +After cloning the repo, run `dep ensure`. + +The command line tool includes build information for debugging. +Please use the provided build script for building: +``` +cd cmd +./build -o jess +./jess version +``` + ### Architecture Before we dive into technical details, here are some more/updated terms: