Products/FastWave2.0
2
0
Fork 0
Code Issues 8 Pull requests Actions Packages Projects Releases 1 Wiki Activity

README update - Start in the browser + Install requirements

Browse source
This commit is contained in:
Martin Kavík 2024-06-01 23:58:27 +02:00
parent 84700cf61b
commit 6cdccb72b2
2 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Makefile.toml
View file

@ -43,7 +43,8 @@ description = "Compile in the release mode and create installation packages"
dependencies = ["tauri_build", "show_release_paths"] dependencies = ["tauri_build", "show_release_paths"]
# @TODO Write task `bundle_browser` once we know whether we need only the frontend # @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 # @TODO: Format also Typescript and CSS
[tasks.format] [tasks.format]

17
README.md
View file

@ -7,14 +7,20 @@
<img width="800" src="https://github.com/JoyOfHardware/FastWave2.0/assets/18517402/87b7cafb-ccdf-4968-8057-3a19632f227f" alt="fastwave_screenshot" /> <img width="800" src="https://github.com/JoyOfHardware/FastWave2.0/assets/18517402/87b7cafb-ccdf-4968-8057-3a19632f227f" alt="fastwave_screenshot" />
</p> </p>
---
### Start: ### Install requirements:
1. Install [Rust](https://www.rust-lang.org/tools/install) 1. Install [Rust](https://www.rust-lang.org/tools/install)
2. Install [Node.js](https://nodejs.org/) 2. Install [Node.js](https://nodejs.org/)
3. `cargo install cargo-make` 3. `cargo install cargo-make`
4. `makers install` 4. `makers install`
5. `makers start`
___
### Start:
1. `makers start`
Troubleshooting: Troubleshooting:
- In case of Tauri compilation errors, install system dependencies: https://beta.tauri.app/guides/prerequisites/ - 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: ### Steps before pushing:
1. `makers format` 1. `makers format`