From 3bb543011c2789057fa1fd87ac9384d63c5014dd Mon Sep 17 00:00:00 2001 From: Tristan Kennedy Date: Wed, 1 Nov 2023 10:56:34 +1100 Subject: [PATCH 1/4] Updated README with install instructions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8751d5f..7d18a08 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,20 @@ The next-generation master server for Northstar. -TODO: Finish the rest of this README. +## Installation +First install GO from here: [https://go.dev/doc/install](https://go.dev/doc/install) + +Then run the following commands: + +```bash +go build cmd/atlas/main.go +``` + +## Usage + +Run the `main.exe` and update your northstar config to point to the new masterserver. + +``` +ns_masterserver_hostname "localhost:8080" +``` \ No newline at end of file From 74b8e17f3db8e091d731a185f4af4d3974857827 Mon Sep 17 00:00:00 2001 From: taskinoz Date: Thu, 9 Nov 2023 21:31:47 +1100 Subject: [PATCH 2/4] Updated build and running instructions --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7d18a08..64c27ca 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,25 @@ The next-generation master server for Northstar. ## Installation -First install GO from here: [https://go.dev/doc/install](https://go.dev/doc/install) +First install Go from here: [https://go.dev/doc/install](https://go.dev/doc/install) Then run the following commands: ```bash -go build cmd/atlas/main.go +go run cmd/atlas/main.go +``` + +## Building + +To build Atlas, run the following command: + +```bash +go build -o atlas.exe cmd/atlas/main.go ``` ## Usage -Run the `main.exe` and update your northstar config to point to the new masterserver. +Run the `main.exe` or directly with `go run cmd/atlas/main.go` and update your northstar config to point to the new masterserver. ``` ns_masterserver_hostname "localhost:8080" From 5bcbc30c8a02a02ca527e15003ec6095efa8d9fb Mon Sep 17 00:00:00 2001 From: Tristan Kennedy Date: Fri, 10 Nov 2023 09:24:16 +1100 Subject: [PATCH 3/4] Updated build/run instructions --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 64c27ca..b1d065f 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ First install Go from here: [https://go.dev/doc/install](https://go.dev/doc/inst Then run the following commands: ```bash -go run cmd/atlas/main.go +go run ./cmd/atlas ``` ## Building @@ -17,12 +17,12 @@ go run cmd/atlas/main.go To build Atlas, run the following command: ```bash -go build -o atlas.exe cmd/atlas/main.go +go build ./cmd/atlas ``` ## Usage -Run the `main.exe` or directly with `go run cmd/atlas/main.go` and update your northstar config to point to the new masterserver. +Run the `main.exe` or directly with `go run ./cmd/atlas` and update your northstar config to point to the new masterserver. ``` ns_masterserver_hostname "localhost:8080" From e5b663f40298c11b611f0e91ae010676a97f007f Mon Sep 17 00:00:00 2001 From: Tristan Kennedy Date: Fri, 10 Nov 2023 14:57:16 +1100 Subject: [PATCH 4/4] Fixed incorrect exe name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1d065f..81982a1 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ go build ./cmd/atlas ## Usage -Run the `main.exe` or directly with `go run ./cmd/atlas` and update your northstar config to point to the new masterserver. +Run the `atlas.exe` or directly with `go run ./cmd/atlas` and update your northstar config to point to the new masterserver. ``` ns_masterserver_hostname "localhost:8080"