Mercurial > gemma

annotate docs/DEVELOPMENT.md @ 4427:b195bc79e3e8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: add hints for starting godoc
author Bernhard Reiter <bernhard@intevation.de>
date Wed, 18 Sep 2019 16:19:59 +0200
parents 9d6ba97a31d2
children 1cb570c69b63
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
291
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
1 # Development
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
2
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
3 ## Backend
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
4
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
5 You need a working [Go](https://golang.org/dl) build environment (1.10+).
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
6
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
7 * Install dependencies
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
8
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
9 `sh 3rdpartylibs`
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
10
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
11 * Build
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
12
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
13 Prerequesite: compile server
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
14 ```
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
15 cd cmd/gemma/
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
16 go build
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
17 cd ../../
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
18 ```
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
19
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
20 * Run
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
21 Run server with `./cmd/gemma/gemma`
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
22
4427
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
23
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
24 ### View source code documentation interactively
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
25
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
26 Use https://godoc.org/golang.org/x/tools/cmd/godoc
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
27 (coming with package `golang-golang-x-tools` on Ubuntu.)
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
28 to see the formatted documentation.
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
29
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
30 Started in the top level directory like
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
31 `godoc -http=:6060`
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
32 you can access the documentation at
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
33 `http://localhost:6060/pkg/gemma.intevation.de/?m=all`
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
34
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
35 Hints:
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
36 * A parameter like `-goroot /usr/lib/go-1.12` may avoid warnings, if
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
37 the goroot is somewhere else.
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
38 * Clicking on a function declaration header will take you to the source
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
39 code. (Or changing `?m=all` to `?m=src?`).
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
40
b195bc79e3e8 docs: add hints for starting godoc
Bernhard Reiter <bernhard@intevation.de>
parents: 291
diff changeset
41
291
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
42 ## Client
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
43
9d6ba97a31d2 Moved development infos to separate file.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
44 See [client/README](../client/README.md) for details.