diff --git a/Makefile.toml b/Makefile.toml index 9d9b9cc..6f1c212 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -43,7 +43,8 @@ description = "Compile in the release mode and create installation packages" dependencies = ["tauri_build", "show_release_paths"] # @TODO Write task `bundle_browser` once we know whether we need only the frontend -# or also the backend side (Moon server) +# or also the backend side (Moon server). +# (Don't forget to add the task to the main README.md) # @TODO: Format also Typescript and CSS [tasks.format] diff --git a/README.md b/README.md index 9827df6..4d98c5f 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,20 @@ fastwave_screenshot

+--- -### Start: +### Install requirements: 1. Install [Rust](https://www.rust-lang.org/tools/install) 2. Install [Node.js](https://nodejs.org/) 3. `cargo install cargo-make` 4. `makers install` -5. `makers start` + +___ + +### Start: + +1. `makers start` Troubleshooting: - In case of Tauri compilation errors, install system dependencies: https://beta.tauri.app/guides/prerequisites/ @@ -29,6 +35,13 @@ Troubleshooting: --- +### Start in the browser: + +1. `makers start_browser` +2. Ctrl + Click the server URL mentioned in the terminal log + +--- + ### Steps before pushing: 1. `makers format`