From 9ab4a3aef2d042f66e2f891cf4e18f8cad6ca073 Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 18:08:28 -0500 Subject: [PATCH 01/10] Add setup instructions --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 6af7fb79e..36f48a097 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # Astronomer CLI +## Setup + +1. Install Go: + + ``` + brew install go + ``` + + More info: https://golang.org/doc/install + +2. Set `GOPATH` (recommended: `~/go`) etc in .bash_profile or .bashrc: + + ``` + export GOPATH=$HOME/go + export GOBIN=$HOME/go/bin + export PATH=$PATH:$GOBIN + ``` + + More info: https://github.com/golang/go/wiki/SettingGOPATH + ### Vendor - All dependnecies are managed with dep, with the exception of libcompose. It needs to be manually added with `go get github.com/docker/libcompose`. Issue here: https://github.com/docker/libcompose/issues/503. - Alternatively, it is also a git submodule, which should get pulled in when cloned. From e6de51997882941de42c6d40d5f153ba2434b560 Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 18:10:34 -0500 Subject: [PATCH 02/10] Add user quickstart --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 36f48a097..d0664d08a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ 1. Install Go: ``` - brew install go + $ brew install go ``` More info: https://golang.org/doc/install @@ -20,6 +20,22 @@ More info: https://github.com/golang/go/wiki/SettingGOPATH +## Quickstart + +How to get started as a user. + +1. Install Astro CLI: + + ``` + $ go get github.com/astronomerio/astro-cli + ``` + +2. Run it to see commands: + + ``` + $ astro-cli + ``` + ### Vendor - All dependnecies are managed with dep, with the exception of libcompose. It needs to be manually added with `go get github.com/docker/libcompose`. Issue here: https://github.com/docker/libcompose/issues/503. - Alternatively, it is also a git submodule, which should get pulled in when cloned. From 1eb396dcb6672eeb3199f89689855126c720356f Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 18:11:26 -0500 Subject: [PATCH 03/10] Add development stub --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d0664d08a..af1e6f768 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,13 @@ How to get started as a user. $ astro-cli ``` +## Development + +How to get started as a developer. + +TODO + ### Vendor + - All dependnecies are managed with dep, with the exception of libcompose. It needs to be manually added with `go get github.com/docker/libcompose`. Issue here: https://github.com/docker/libcompose/issues/503. - Alternatively, it is also a git submodule, which should get pulled in when cloned. From 262bcea75c910c6fb74ad412b196e7d4b2d02817 Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 18:12:00 -0500 Subject: [PATCH 04/10] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index af1e6f768..0cbc379f6 100644 --- a/README.md +++ b/README.md @@ -44,5 +44,5 @@ TODO ### Vendor -- All dependnecies are managed with dep, with the exception of libcompose. It needs to be manually added with `go get github.com/docker/libcompose`. Issue here: https://github.com/docker/libcompose/issues/503. +- All dependencies are managed with dep, with the exception of libcompose. It needs to be manually added with `go get github.com/docker/libcompose`. Issue here: https://github.com/docker/libcompose/issues/503. - Alternatively, it is also a git submodule, which should get pulled in when cloned. From 113793098aa3a5155da3869d3fedb478b8f5b57e Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 18:24:29 -0500 Subject: [PATCH 05/10] Add developer instructions --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cbc379f6..9d62f2200 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,20 @@ How to get started as a user. How to get started as a developer. -TODO +1. Build: + + ``` + git clone git@github.com:astronomerio/astro-cli.git + cd astro-cli + make build + make install + ``` + +2. Run: + + ``` + $ astro + ``` ### Vendor From c1188726a0f785941c2638312ae4aab9178d5da3 Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 18:26:12 -0500 Subject: [PATCH 06/10] Make install optional --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d62f2200..c4b3825c3 100644 --- a/README.md +++ b/README.md @@ -46,10 +46,15 @@ How to get started as a developer. git clone git@github.com:astronomerio/astro-cli.git cd astro-cli make build + ``` + +2. (Optional) Install to `$GOBIN`: + + ``` make install ``` -2. Run: +3. Run: ``` $ astro From 581b23f52f42d58e502217d575051f580cb72038 Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 19:24:45 -0500 Subject: [PATCH 07/10] Add create a project instructions --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index c4b3825c3..322618936 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,13 @@ How to get started as a user. $ astro-cli ``` +3. Create a project: + + ``` + $ mkdir hello-astro && cd hello-astro + $ astro airflow init + ``` + ## Development How to get started as a developer. From f39dd7964a0eef43549e4a58e2f1311e194ba75a Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 19:25:13 -0500 Subject: [PATCH 08/10] Start all commands with $ --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 322618936..115075bae 100644 --- a/README.md +++ b/README.md @@ -50,15 +50,15 @@ How to get started as a developer. 1. Build: ``` - git clone git@github.com:astronomerio/astro-cli.git - cd astro-cli - make build + $ git clone git@github.com:astronomerio/astro-cli.git + $ cd astro-cli + $ make build ``` 2. (Optional) Install to `$GOBIN`: ``` - make install + $ make install ``` 3. Run: From 8493b00d37780f316d1b2e86928580f7e383f094 Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 19:28:05 -0500 Subject: [PATCH 09/10] Use right command --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 115075bae..c1466f542 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ How to get started as a user. ``` $ mkdir hello-astro && cd hello-astro - $ astro airflow init + $ astro-cli airflow init ``` ## Development From 5bf3bdfb517e9f7a37b4e6f286b127e649692c02 Mon Sep 17 00:00:00 2001 From: "Taylor D. Edmiston" Date: Fri, 16 Feb 2018 19:31:58 -0500 Subject: [PATCH 10/10] Lint --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c1466f542..bcfc0afae 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ $ brew install go ``` - More info: https://golang.org/doc/install + More info: -2. Set `GOPATH` (recommended: `~/go`) etc in .bash_profile or .bashrc: +1. Set `GOPATH` (recommended: `~/go`) in .bash_profile or .bashrc: ``` export GOPATH=$HOME/go @@ -18,7 +18,7 @@ export PATH=$PATH:$GOBIN ``` - More info: https://github.com/golang/go/wiki/SettingGOPATH + More info: ## Quickstart @@ -30,13 +30,13 @@ How to get started as a user. $ go get github.com/astronomerio/astro-cli ``` -2. Run it to see commands: +1. Run it to see commands: ``` $ astro-cli ``` -3. Create a project: +1. Create a project: ``` $ mkdir hello-astro && cd hello-astro @@ -55,13 +55,13 @@ How to get started as a developer. $ make build ``` -2. (Optional) Install to `$GOBIN`: +1. (Optional) Install to `$GOBIN`: ``` $ make install ``` -3. Run: +1. Run: ``` $ astro @@ -69,5 +69,5 @@ How to get started as a developer. ### Vendor -- All dependencies are managed with dep, with the exception of libcompose. It needs to be manually added with `go get github.com/docker/libcompose`. Issue here: https://github.com/docker/libcompose/issues/503. +- All dependencies are managed with dep, with the exception of libcompose. It needs to be manually added with `go get github.com/docker/libcompose`. Issue here: . - Alternatively, it is also a git submodule, which should get pulled in when cloned.