github/wails
5
0
Fork 0
mirror of https://github.com/wailsapp/wails.git synced 2025-05-05 05:52:33 +08:00
Code Projects Activity

More docs.

Browse Source
This commit is contained in:
Lea Anthony 2023-09-04 22:50:09 +10:00
parent 708aef53e4
commit eb2ad258ed
No known key found for this signature in database
GPG Key ID: 33DAF7BB90A58405
4 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
mkdocs-website/docs/development/introduction.md
View File

@ -1,13 +1,14 @@
# Introduction # 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. Thanks for wanting to help out with development of Wails! This guide will help you get started.
## Getting Started ## Getting Started
- Git clone this repository. Checkout the `v3-alpha` branch. - 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). - 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: The runtime is located in `v3/internal/runtime`. When the runtime is updated, the following steps need to be taken:
```shell ```shell
wails task runtime:build wails3 task runtime:build
``` ```
### Events ### Events

3
mkdocs-website/docs/getting-started/feedback.md
View File

@ -40,6 +40,9 @@ Things we are looking for feedback on:
- The API - The API
- Is it easy to use? - Is it easy to use?
- Does it do what you expect? - 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 - The build system
- Is it easy to use? - Is it easy to use?
- Can we improve it? - Can we improve it?

6
mkdocs-website/docs/getting-started/installation.md
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 is installed correctly: `go version`
- Check `~/go/bin` is in your PATH variable: `echo $PATH | grep go/bin` - 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. Run `npm --version` to verify.

2
mkdocs-website/overrides/home.html
View File

@ -73,7 +73,7 @@
This site will be updated as we progress through the alpha and beta releases.<br/><br/> This site will be updated as we progress through the alpha and beta releases.<br/><br/>
v3 is a work in progress. Expect things to fail. Expect things to change.<br/><br/> v3 is a work in progress. Expect things to fail. Expect things to change. Expect the documentation to be wrong.<br/><br/>
Please feel free to raise PRs against this website. Every single PR helps us get closer to a release.<br/><br/> Please feel free to raise PRs against this website. Every single PR helps us get closer to a release.<br/><br/>
Thank you for sharing this journey with us.<br/><br/> Thank you for sharing this journey with us.<br/><br/>