5
0
mirror of https://github.com/wailsapp/wails.git synced 2025-05-07 00:39:18 +08:00

More docs.

This commit is contained in:
Lea Anthony 2023-09-04 22:40:40 +10:00
parent 3e74255127
commit e893c1c205
No known key found for this signature in database
GPG Key ID: 33DAF7BB90A58405
2 changed files with 46 additions and 0 deletions

View File

@ -33,3 +33,21 @@ We welcome (and encourage) your feedback! Here are the different ways to provide
- Posts can be "upvoted" by using the :thumbsup: emoji. Please apply to any posts that are a priority for you. - Posts can be "upvoted" by using the :thumbsup: emoji. Please apply to any posts that are a priority for you.
- Please *don't* just add comments like "+1" or "me too". - Please *don't* just add comments like "+1" or "me too".
- Please feel free to comment if there is more to add to the post, such as "this bug also affect ARM builds" or "Another option would be to ....." - Please feel free to comment if there is more to add to the post, such as "this bug also affect ARM builds" or "Another option would be to ....."
Things we are looking for feedback on:
- The API
- Is it easy to use?
- Does it do what you expect?
- The build system
- Is it easy to use?
- Can we improve it?
- The examples
- Are they clear?
- Do they cover the basics?
- Features
- What features are missing?
- What features are not needed?
- Documentation
- What could be clearer?

View File

@ -3,3 +3,31 @@
Now that you have Wails installed, you can start exploring the alpha version. Now that you have Wails installed, you can start exploring the alpha version.
The best place to start is the `examples` directory in the Wails repository. This contains a number of examples that you can run and play with. The best place to start is the `examples` directory in the Wails repository. This contains a number of examples that you can run and play with.
## Running an example
To run an example, you can simply use:
```shell
go run .
```
in the example directory.
## Creating a new project
To create a new project, you can use the `wails3 init` command. This will create a new project in the current directory.
Wails3 uses [Task](https://taskfile.dev) as its build system by default, although there is no reason why you can't
use your own build system, or use `go build` directly. Wails has the task build system built in and can be run using `wails3 task`.
If you look through the `Taskfile.yaml` file, you will see that there are a number of tasks defined. The most important
one is the `build` task. This is the task that is run when you use `wails3 build`.
The task file is unlikely to be complete and is subject to change over time.
## Building a project
To build a project, you can use the `wails3 build` command. This is a shortcut for `wails3 task build`.