Skip to content

Commit

Permalink
Update alpha docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leaanthony committed Jan 13, 2024
1 parent a6757c3 commit ab22ea1
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 8 deletions.
77 changes: 74 additions & 3 deletions mkdocs-website/docs/en/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,82 @@ The roadmap is a living document and is subject to change. If you have any
suggestions, please open an issue. Each milestone will have a set of goals that
we are aiming to achieve. These are subject to change.

## Known Issues

- Generating bindings for a method that imports a package that has the same name as another imported package is currently not supported.

## Alpha milestones

### Current: Alpha 3
### Current: Alpha 4

#### Goals

The Alpha 4 cycle aims to provide the `dev` and `package` commands.
The `wails dev` command should do the following:
- Build the application
- Start the application
- Start the frontend dev server
- Watch for changes to the application code and rebuild/restart as necessary

The `wails package` command should do the following:
- Build the application
- Package the application in a platform specific format
- Windows: Standard executable, NSIS Installer
- Linux: AppImage
- MacOS: Standard executable, App Bundle
- Support obfuscation of the application code

- We also want to get all examples working on Linux.

#### How Can I Help?

!!! note
Report any issues you find using [this guide](./getting-started/feedback.md).


- Install the CLI using the instructions [here](./getting-started/installation).
- Run `wails3 doctor` and ensure that all dependencies are installed.
- Generate a new project using `wails3 init`.

Test the `wails3 dev` command:

- Run `wails3 dev` in the project directory. It should run the application in development mode.
- Try changing files and ensure that the application is rebuilt and restarted.
- Run `wails3 dev -help` to view options.
- Try different options and ensure that they work as expected.

Test the `wails3 package` command:

- Run `wails3 package` in the project directory.
- Check that the application is packaged correctly for the current platform.
- Run `wails3 package -help` to view options.
- Try different options and ensure that they work as expected.

Review the table below and look for untested scenarios.
Basically, try to break it and let us know if you find any issues! :smile:

#### Status

`wails3 dev` command:

- :material-check-bold: - Working
- :material-minus: - Partially working
- :material-close: - Not working

{{ read_csv("alpha4-wails3-dev.csv") }}


`wails3 package` command:

- :material-check-bold: - Working
- :material-minus: - Partially working
- :material-close: - Not working
- :material-cancel: - Not Supported

{{ read_csv("alpha4-wails3-package.csv") }}


### Alpha 3 - Completed 2024-01-14

#### Goals

Expand Down Expand Up @@ -61,8 +134,6 @@ Examples:

#### Goals

- [ ] `wails3 dev` command
- [ ] `wails3 package` command

### Alpha 5

Expand Down
2 changes: 1 addition & 1 deletion mkdocs-website/shared/alpha3-bindings-callbyid.csv
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Scenario,Windows,Mac,Linux
Same package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Different package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Different package with same name," "," "," "
Different package with same name,"on hold","on hold","on hold"
Containing another struct from same package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Containing another struct from different package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Containing an anonymous struct,:material-check-bold:,:material-check-bold:,:material-check-bold:
2 changes: 1 addition & 1 deletion mkdocs-website/shared/alpha3-bindings-callbyname.csv
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Scenario,Windows,Mac,Linux
Same package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Different package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Different package with same name," "," "," "
Different package with same name,"on hold","on hold","on hold"
Containing another struct from same package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Containing another struct from different package,:material-check-bold:,:material-check-bold:,:material-check-bold:
Containing an anonymous struct,:material-check-bold:,:material-check-bold:,:material-check-bold:
2 changes: 2 additions & 0 deletions mkdocs-website/shared/alpha4-wails3-dev.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
" ",Mac,Windows,Linux
`wails3 dev`," "," "," "
5 changes: 5 additions & 0 deletions mkdocs-website/shared/alpha4-wails3-package.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
" ",Mac,Windows,Linux
Standard Executable," "," "," "
macOS Application Bundle," ",:material-cancel:,:material-cancel:
NSIS," "," "," "
macOS DMG," ",:material-cancel:,:material-cancel:
3 changes: 0 additions & 3 deletions mkdocs-website/shared/alpha4.csv

This file was deleted.

0 comments on commit ab22ea1

Please sign in to comment.