We be launching the engines boiiiii
This launcher is under heavy development, and so we do not have releases available. While we will be setting up a CI for nightly builds, keep in mind however that this is only intended for testing!
Want to contribute! Great! I love you and I will give my life to you. Please marry me. All you have to do is make a pull request!
Not a developer? You can still contribute! Don't be shy to open an issue and explain your problems with the program in detail.
The following section are for developers.
This project uses Tauri v2. Below are the steps to setup your development environment.
Install the system dependencies as listed in the official guide here, make sure to follow the steps according to your OS. In general, you will need:
- Rust toolchain
- Node.js
npmorpnpm(we only maintain lockfiles for those package managers)- Recommended: Visual Studio Code (use any text editor of choice, but we maintain settings for VSCode only)
- Install Node dependencies. On npm:
npm install. - Test with a single command. On npm:
npm run tauri dev. This will compile the Rust library, launch a development server, and run the test application.
Coming soon.
We have set up a few conventions to keep the repository organized.
Except for master, branches follow this naming convention: <type>/<title>, where <type> is the type of changes you're about to apply, and <title> is the title describing those changes. Names should use kebab-case. List of types is as follows:
fix: patching a bugfeat: introducing a featuredocs: documentationbuild: additions to the build systemchore: mundane clean-upmisc: other
Example: feat/more-cats
TODO: add a license as soon as possible