From dab48497c198e0cd45f72dd38ccd52413884f85e Mon Sep 17 00:00:00 2001 From: sawka Date: Wed, 12 Jun 2024 10:46:22 -0700 Subject: [PATCH] updated README with new build/run instructions --- README.md | 38 ++++++++++---------------------------- 1 file changed, 10 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 03cd60060..f0224cbe4 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,28 @@ # 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). +Prereqs: -Install task: +You'll need to install "task" (which we're using as a build/run system): ``` -brew install go-task/tap/go-task +brew install go-task ``` -Install wails3: +On first checkout: ``` -git clone git@github.com:wailsapp/wails.git -cd wails -git checkout v3-alpha -cd v3/cmd/wails3 -go install +yarn +go mod tidy ``` -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). +To run the app, you'll first need to run the webpack watcher: ``` -# move back to the *parent* directory of your wails clone -git clone git@github.com:wavetermdev/thenextwave.git -cd thenextwave +task webpack ``` -Now to run the dev version of the app: +Then, in a separate terminal, this command will run the electron app: ``` -wails3 dev +task electron ``` - -You should see the 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).