Added development documentation

.gitignore

@@ -2,9 +2,17 @@
 /bin
 /.go
 
+# Linuxkit build
+rpi3.yml
+*-cmdline
+*-initrd.img
+*-kernel
+*-state
+
 node_modules
 # Ignore because just used with gitbook
 package-lock.json
 
 # Output of documentation
 _book
+

README.md

@@ -1,5 +1,5 @@
 
-![Eliot](docs/eliot-logo-medium.png) [![Go Report Card](https://goreportcard.com/badge/github.com/ernoaapa/eliot)](https://goreportcard.com/report/github.com/ernoaapa/eliot) [![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/eliot-run)
+![Eliot](docs/eliot-logo-medium.png) [![Go Report Card](https://goreportcard.com/badge/github.com/ernoaapa/eliot)](https://goreportcard.com/report/github.com/ernoaapa/eliot)
 
 > This is early alpha version! There's not all features yet implemented, not heavily tested with different devices and code might get large breaking changes until the first release.
 
@@ -31,4 +31,51 @@ Eliot is built from following components
 [Let us know](https://github.com/ernoaapa/eliot/issues/new) what would be the next awesome feature :)
 
 ## Getting started
-[See the documentation how to get started](http://docs.eliot.run/getting_started.html)
+[See the documentation](http://docs.eliot.run/getting_started.html) how to get started with Eliot.
+
+**Rest of this document is about developing Eliot itself, not how to develop on top of the Eliot.**
+
+## Development
+
+### Prerequisites
+- [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- [Install Golang 1.10](https://golang.org/doc/install)
+- [Install Docker](https://docs.docker.com/install/)
+- [Install Linuxkit](https://github.com/linuxkit/linuxkit#build-the-linuxkit-tool)
+- [Install goreleaser](https://goreleaser.com/#introduction.installing_goreleaser) (for building `eliotd`)
+- Get Eliot source code `git clone https://github.com/ernoaapa/eliot && cd eliot`
+
+### Developing `eli` cli
+If you're making changes to the `eli` command line tool, you can just build and run the command
+```shell
+go run ./cmd/eli/* get nodes
+```
+
+### Developing `eliotd` daemon
+To develop `eliotd` there's two different ways; latter is not tested
+- run `eliotd` in EliotOS with Linuxkit
+- run `eliotd` daemon locally
+
+#### Run EliotOS locally
+For development purpose, you can build and run the [EliotOS](https://github.com/ernoaapa/eliot-os) locally, but keep in mind that the **environment is amd64 not arm64** so container images what work in this environment might not work in RaspberryPI if the images are not multi-arch images.
+
+1. Build `eliotd` binary and Docker image
+   - `goreleaser --snapshot --rm-dist`
+2. Get EliotOS linuxkit configuration
+   - `curl https://raw.githubusercontent.com/ernoaapa/eliot-os/master/rpi3.yml > rpi3.yml`
+3. Update `rpi3.yml`
+   - Check from `goreleaser` the `amd64` container image name
+   - Edit the `rpi3.yml` and update the `eliotd` image tag to match with the previous value
+4. Build EliotOS image:
+   - `linuxkit build rpi3.yml`
+5. Start image:
+   - MacOS: `sudo linuxkit run hyperkit -cpus 1 -mem "1048" -disk size=10G -networking vmnet moby`
+6. Test connection
+   - `eli get nodes`
+
+#### Run `eliotd` locally
+This is not tested, but should go roughly like this:
+
+1. Install [runc](https://github.com/opencontainers/runc)
+2. Install [containerd](https://github.com/containerd/containerd/blob/master/docs/getting-started.md#starting-containerd)
+3. Run `go run ./cmd/eliotd/* --debug --grpc-api-listen 0.0.0.0:5000`