grim/hgkeeper

Add instructions on how to build

2019-09-11, Gary Kramlich
33b5ec0c4636
Parents da90fbb024f0
Children 2664db87766e
Add instructions on how to build
1 files changed, 18 insertions(+), 0 deletions(-)
  • +18 -0
    README.md
    • --- a/README.md Tue Sep 10 23:41:43 2019 -0500
    +++ b/README.md Wed Sep 11 01:04:01 2019 -0500
    @@ -15,6 +15,24 @@
    This project is brand new and not even functional yet... But if you're
    interested in helping, please do!!
    +## Building
    +
    +This project needs to generate so source files, so you'll need to first install
    +the embedding tool [esc](https://github.com/mjibson/esc).
    +
    +```
    +$ go get -u github.com/mjibson/esc
    +```
    +
    +Once esc is installed, make sure it's available on your path.
    +
    +Then you can build hgkeeper with the following commands:
    +
    +```
    +$ go generate ./...
    +$ go build
    +```
    +
    ## Getting Started
    The initial setup of hgkeeper has a few steps. Since hgkeeper is an SSH server