README.md - Issue 2182213002: deploytool: Add README.md, migrate docs to it.

Side by Side Diff: README.md

Issue 2182213002: deploytool: Add README.md, migrate docs to it. (Closed) Base URL: https://github.com/luci/luci-go@master

Patch Set: Rename to "luci_deploy" Created 4 years, 4 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

OLD	NEW
1 luci-go: LUCI services and tools in Go	1 luci-go: LUCI services and tools in Go

2 ======================================	2 ======================================

3	3

4 [![GoDoc](https://godoc.org/github.com/luci/luci-go?status.svg)](https://godoc.o rg/github.com/luci/luci-go)	4 [![GoDoc](https://godoc.org/github.com/luci/luci-go?status.svg)](https://godoc.o rg/github.com/luci/luci-go)

5 [![Build Status](https://travis-ci.org/luci/luci-go.svg?branch=master)](https:// travis-ci.org/luci/luci-go)	5 [![Build Status](https://travis-ci.org/luci/luci-go.svg?branch=master)](https:// travis-ci.org/luci/luci-go)

6 [![Coverage Status](https://coveralls.io/repos/luci/luci-go/badge.svg?branch=mas ter&service=github)](https://coveralls.io/github/luci/luci-go?branch=master)	6 [![Coverage Status](https://coveralls.io/repos/luci/luci-go/badge.svg?branch=mas ter&service=github)](https://coveralls.io/github/luci/luci-go?branch=master)

7	7

8 Installing	8 Installing

9 ----------	9 ----------

10	10

11 go get -u github.com/luci/luci-go/client/cmd/...	11 go get -u github.com/luci/luci-go/client/cmd/...

12 go get -u github.com/luci/luci-go/server/cmd/...	12 go get -u github.com/luci/luci-go/server/cmd/...

13	13

14	14

15 Code layout	15 Code layout

16 -----------	16 -----------

17	17

18 * [/appengine/...](https://github.com/luci/luci-go/tree/master/appengine)	18 * [/appengine/...](https://github.com/luci/luci-go/tree/master/appengine)

19 contains [AppEngine](https://cloud.google.com/appengine/docs/go/) server	19 contains [AppEngine](https://cloud.google.com/appengine/docs/go/) server

20 code. It imports packages from `/common/...` and `/server/...`.	20 code. It imports packages from `/common/...` and `/server/...`.

21 * [/client/...](https://github.com/luci/luci-go/tree/master/client) contains	21 * [/client/...](https://github.com/luci/luci-go/tree/master/client) contains

22 all client code.	22 all client code.

23 * [/common/...](https://github.com/luci/luci-go/tree/master/common) contains	23 * [/common/...](https://github.com/luci/luci-go/tree/master/common) contains

24 code and structures shared between all of `/appengine/...`, `/client/...`	24 code and structures shared between all of `/appengine/...`, `/client/...`

25 and `/server/...`; for example, the structures used by the server APIs.	25 and `/server/...`; for example, the structures used by the server APIs.

26 These are inherently APIs.	26 These are inherently APIs.

	27 * [/deploytool/...](https://github.com/luci/luci-go/tree/master/deploytool)

	28 contains the LUCI cloud services deployment tool.

	29 * [/logdog/...](https://github.com/luci/luci-go/tree/master/logdog) contains

	30 LogDog client and server code, as well as APIs, protobufs, and support

	31 libraries.

27 * [/server/...](https://github.com/luci/luci-go/tree/master/server) contains	32 * [/server/...](https://github.com/luci/luci-go/tree/master/server) contains

28 standalone server code. Its packages are reusable by `/appengine/...`.	33 standalone server code. Its packages are reusable by `/appengine/...`.

29 * [/tools/...](https://github.com/luci/luci-go/tree/master/tools) contains	34 * [/tools/...](https://github.com/luci/luci-go/tree/master/tools) contains

30 support tools used by other LUCI components.	35 support tools used by other LUCI components.

31	36

32	37

33 Versioning	38 Versioning

34 ----------	39 ----------

35	40

36 * Branch `go1` contains the stable code.	41 * Branch `go1` contains the stable code.

(...skipping 20 matching lines...) Expand all Loading...
57 # hack hack	62 # hack hack

58	63

59 git commit -a -m "This is awesome\nR=joe@example.com"	64 git commit -a -m "This is awesome\nR=joe@example.com"

60 # This will ask for your Google Account credentials.	65 # This will ask for your Google Account credentials.

61 git cl upload -s	66 git cl upload -s

62 # Wait for LGTM over email.	67 # Wait for LGTM over email.

63 # Check the commit queue box in codereview website.	68 # Check the commit queue box in codereview website.

64 # Wait for the change to be tested and landed automatically.	69 # Wait for the change to be tested and landed automatically.

65	70

66 Use `git cl help` and `git cl help <cmd>` for more details.	71 Use `git cl help` and `git cl help <cmd>` for more details.

OLD	NEW

« no previous file with comments | « .luci-deploytool.cfg ('k') | deploytool/README.md » ('j') | no next file with comments »