From 6ae6aa8ea554cb110a176f96d75555fa7024d8af Mon Sep 17 00:00:00 2001
From: sawka <mike.sawka@gmail.com>
Date: Thu, 9 May 2024 20:38:54 -0700
Subject: [PATCH] new readme

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..846e245a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# The Next Wave
+
+To build you need to have wails3 installed. You need to check out the repo, switch to the `v3-alpha` branch, then install the `wails3` command. you should also install the "task" command (wails3 uses a Taskfile.yml file).
+
+Install task:
+
+```
+brew install go-task/tap/go-task
+```
+
+Install wails3:
+
+```
+git clone git@github.com:wailsapp/wails.git
+cd wails
+git checkout v3-alpha
+cd v3/cmd/wails3
+go install
+```
+
+To test if wails3 is installed correctly you can run `wails3 doctor` (it should say "success" at the bottom).
+
+Now, this directory must live as a sibling to `thenextwave` repo (because we have a special replace directive in the go.mod file).
+
+```
+# move back to the *parent* directory of your wails clone
+git clone git@github.com:wavetermdev/thenextwave.git
+cd thenextwave
+```
+
+Now to run the dev version of the app:
+
+```
+wails3 dev
+```
+
+You should see a very poorly laid out app :)
+
+Now to build a MacOS application:
+
+```
+task build
+task create:app:bundle
+```
+
+now in your `./bin` directory you should see `bin/NextWave` (a standalone executable), and you'll also see `bin/NextWave.app` which is a MacOS application. You can run `bin/NextWave` directly, or run the app using `open bin/NextWave.app` (or click on it in the finder).