diff --git a/mkdocs-website/docs/en/roadmap.md b/mkdocs-website/docs/en/roadmap.md index fb16c615d4a..8e5a11b7643 100644 --- a/mkdocs-website/docs/en/roadmap.md +++ b/mkdocs-website/docs/en/roadmap.md @@ -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 diff --git a/mkdocs-website/shared/alpha3-bindings-callbyid.csv b/mkdocs-website/shared/alpha3-bindings-callbyid.csv index a09e5036e7b..8483f206831 100644 --- a/mkdocs-website/shared/alpha3-bindings-callbyid.csv +++ b/mkdocs-website/shared/alpha3-bindings-callbyid.csv @@ -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: diff --git a/mkdocs-website/shared/alpha3-bindings-callbyname.csv b/mkdocs-website/shared/alpha3-bindings-callbyname.csv index a09e5036e7b..8483f206831 100644 --- a/mkdocs-website/shared/alpha3-bindings-callbyname.csv +++ b/mkdocs-website/shared/alpha3-bindings-callbyname.csv @@ -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: diff --git a/mkdocs-website/shared/alpha4-wails3-dev.csv b/mkdocs-website/shared/alpha4-wails3-dev.csv new file mode 100644 index 00000000000..12b4dfc45e1 --- /dev/null +++ b/mkdocs-website/shared/alpha4-wails3-dev.csv @@ -0,0 +1,2 @@ +" ",Mac,Windows,Linux +`wails3 dev`," "," "," " \ No newline at end of file diff --git a/mkdocs-website/shared/alpha4-wails3-package.csv b/mkdocs-website/shared/alpha4-wails3-package.csv new file mode 100644 index 00000000000..4f1a2a87512 --- /dev/null +++ b/mkdocs-website/shared/alpha4-wails3-package.csv @@ -0,0 +1,5 @@ +" ",Mac,Windows,Linux +Standard Executable," "," "," " +macOS Application Bundle," ",:material-cancel:,:material-cancel: +NSIS," "," "," " +macOS DMG," ",:material-cancel:,:material-cancel: diff --git a/mkdocs-website/shared/alpha4.csv b/mkdocs-website/shared/alpha4.csv deleted file mode 100644 index 36669c75d27..00000000000 --- a/mkdocs-website/shared/alpha4.csv +++ /dev/null @@ -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: