adapt docs structure

2020-09-21 13:20:14 +02:00
parent 696b9a70af
commit c41440e008
87 changed files with 917 additions and 822 deletions
@@ -0,0 +1,28 @@
+---
+title: "Building"
+date: 2020-02-21T00:00:00+00:00
+weight: 30
+geekdocRepo: https://github.com/owncloud/ocis-konnectd
+geekdocEditPath: edit/master/docs
+geekdocFilePath: building.md
+---
+
+{{< toc >}}
+
+As this project is built with Go, so you need to install that first. The installation of Go is out of the scope of this document, please follow the official documentation for [Go](https://golang.org/doc/install), to build this project you have to install Go >= v1.13. After the installation of the required tools you need to get the sources:
+
+{{< highlight txt >}}
+git clone https://github.com/owncloud/ocis-konnectd.git
+cd ocis-konnectd
+{{< / highlight >}}
+
+All required tool besides Go itself and make are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile`.
+
+## Backend
+
+{{< highlight txt >}}
+make generate
+make build
+{{< / highlight >}}
+
+Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-konnectd -h` to see all available options and subcommands.