From 98ba7fe23c89d13a517d227ba5d4434b599b2658 Mon Sep 17 00:00:00 2001 From: Daniel Jaglowski Date: Mon, 20 Jul 2020 14:49:31 -0400 Subject: [PATCH] Added basic developer documentation (#43) * Added basic developer documentation * Downcase observiq in directory names --- 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..063910844 --- /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