Update alpha docs

This commit is contained in:
Lea Anthony
2024-01-14 09:22:27 +11:00
parent a6757c352f
commit ab22ea1f27
6 changed files with 83 additions and 8 deletions
+74 -3
View File
@@ -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
@@ -61,8 +134,6 @@ Examples:
#### Goals
- [ ] `wails3 dev` command
- [ ] `wails3 package` command
### Alpha 5
@@ -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:
1 Scenario Windows Mac Linux
2 Same package :material-check-bold: :material-check-bold: :material-check-bold:
3 Different package :material-check-bold: :material-check-bold: :material-check-bold:
4 Different package with same name on hold on hold on hold
5 Containing another struct from same package :material-check-bold: :material-check-bold: :material-check-bold:
6 Containing another struct from different package :material-check-bold: :material-check-bold: :material-check-bold:
7 Containing an anonymous struct :material-check-bold: :material-check-bold: :material-check-bold:
@@ -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:
1 Scenario Windows Mac Linux
2 Same package :material-check-bold: :material-check-bold: :material-check-bold:
3 Different package :material-check-bold: :material-check-bold: :material-check-bold:
4 Different package with same name on hold on hold on hold
5 Containing another struct from same package :material-check-bold: :material-check-bold: :material-check-bold:
6 Containing another struct from different package :material-check-bold: :material-check-bold: :material-check-bold:
7 Containing an anonymous struct :material-check-bold: :material-check-bold: :material-check-bold:
@@ -0,0 +1,2 @@
" ",Mac,Windows,Linux
`wails3 dev`," "," "," "
1 Mac Windows Linux
2 `wails3 dev`
@@ -0,0 +1,5 @@
" ",Mac,Windows,Linux
Standard Executable," "," "," "
macOS Application Bundle," ",:material-cancel:,:material-cancel:
NSIS," "," "," "
macOS DMG," ",:material-cancel:,:material-cancel:
1 Mac Windows Linux
2 Standard Executable
3 macOS Application Bundle :material-cancel: :material-cancel:
4 NSIS
5 macOS DMG :material-cancel: :material-cancel:
-3
View File
@@ -1,3 +0,0 @@
" ",Mac,Windows,Linux,WSL
`wails dev`," ",:material-check-bold:," ",:material-minus:
`wails package`," ",:material-check-bold:,:material-check-bold:,:material-check-bold:
1 Mac Windows Linux WSL
2 `wails dev` :material-check-bold: :material-minus:
3 `wails package` :material-check-bold: :material-check-bold: :material-check-bold: