waveterm/wails
0
0
Fork 0
mirror of https://github.com/wavetermdev/wails.git synced 2026-08-05 13:53:43 -07:00
Code Issues Packages Projects Releases Wiki Activity

More docs.

Browse Source
This commit is contained in:
Lea Anthony
2023-09-04 22:51:21 +10:00
parent 708aef53e4
commit eb2ad258ed
4 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mkdocs-website/docs/development/introduction.md
+4 -3
View File
@@ -1,13 +1,14 @@
# Introduction
**This guide is a work in progress.**
!!! note
This guide is a work in progress.
Thanks for wanting to help out with development of Wails! This guide will help you get started.
## Getting Started
- Git clone this repository. Checkout the `v3-alpha` branch.
- Install the CLI: `cd v3/cmd/3wails && go install`
- Install the CLI: `cd v3/cmd/wails3 && go install`
- Optional: If you are wanting to use the build system to build frontend code, you will need to install [npm](https://nodejs.org/en/download).
@@ -57,7 +58,7 @@ Most, if not all, of the platform specific code should be run on the main thread
The runtime is located in `v3/internal/runtime`. When the runtime is updated, the following steps need to be taken:
```shell
wails task runtime:build
wails3 task runtime:build
```
### Events
mkdocs-website/docs/getting-started/feedback.md
+3
View File
@@ -40,6 +40,9 @@ Things we are looking for feedback on:
- The API
- Is it easy to use?
- Does it do what you expect?
- Is it missing anything?
- Is there anything that should be removed?
- Is it consistent between Go and JS?
- The build system
- Is it easy to use?
- Can we improve it?
mkdocs-website/docs/getting-started/installation.md
+4 -2
View File
@@ -27,9 +27,11 @@ Wails has a number of common dependencies that are required before installation:
- Check Go is installed correctly: `go version`
- Check `~/go/bin` is in your PATH variable: `echo $PATH | grep go/bin`
=== "NPM (Node 18+)"
=== "npm (Optional)"
Download NPM from the [Node Downloads Page](https://nodejs.org/en/download/). It is best to use the latest release as that is what we generally test against.
Although Wails doesn't require npm to be installed, it is needed if you want to use the bundled templates.
Download the latest node installer from the [Node Downloads Page](https://nodejs.org/en/download/). It is best to use the latest release as that is what we generally test against.
Run `npm --version` to verify.