From b66b1a7364947385463780ed3dc2920fe76ac0a8 Mon Sep 17 00:00:00 2001 From: Dan Jaglowski Date: Mon, 20 Jul 2020 14:16:52 -0400 Subject: [PATCH 1/2] Added basic developer documentation --- docs/development.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/development.md diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 000000000..bf3e8d3c7 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,25 @@ +## Setup + +If you are new to Go, it is recommended to work through the [How to Write Go Code](https://golang.org/doc/code.html) tutorial, which will ensure your Go environment is configured. + +Clone this repo into your Go workspace: +``` +cd $GOPATH/src +mkdir -p github.com/observIQ && cd github.com/observIQ +git clone git@github.com:observIQ/carbon.git +cd $GOPATH/src/github.com/observIQ/carbon +``` + +## Building + +To build the agent for another OS, run one of the following: +``` +make build // local OS +make build-windows-amd64 +make build-linux-amd64 +make build-darwin-amd64 +``` + +## Running Tests + +Tests can be run with `make test`. \ No newline at end of file From b1aad3c3eee63a143fdc636cf287d3c006eceac5 Mon Sep 17 00:00:00 2001 From: Dan Jaglowski Date: Mon, 20 Jul 2020 14:18:55 -0400 Subject: [PATCH 2/2] Downcase observiq in directory names --- docs/development.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/development.md b/docs/development.md index bf3e8d3c7..063910844 100644 --- a/docs/development.md +++ b/docs/development.md @@ -5,9 +5,9 @@ If you are new to Go, it is recommended to work through the [How to Write Go Cod Clone this repo into your Go workspace: ``` cd $GOPATH/src -mkdir -p github.com/observIQ && cd github.com/observIQ -git clone git@github.com:observIQ/carbon.git -cd $GOPATH/src/github.com/observIQ/carbon +mkdir -p github.com/observiq && cd github.com/observiq +git clone git@github.com:observiq/carbon.git +cd $GOPATH/src/github.com/observiq/carbon ``` ## Building