Updated README.md

This commit is contained in:
2024-11-29 11:51:21 -07:00
parent 372f29c939
commit 81a165c11b
+25 -11
View File
@@ -1,19 +1,33 @@
# README
## About
# Canvas Launcher
This is the official Wails Vue-TS template.
A custom Minecraft launcher designed as a Technic replacement. This launcher is designed to be reskinned by each modpack installed.
You can configure the project by editing `wails.json`. More information about the project settings can be found
here: https://wails.io/docs/reference/project-config
Modpacks can be added via zip files, the Technic platform, or the complimentary project Palette.
## Installation
To start developing you'll need Go and NodeJS + NPM installed. Afterwards you'll need to install Wails. Wails requires additional system libraries. `wails doctor` scans your system for the libraries required.
```bash
go install github.com/wailsapp/wails/v2/cmd/wails@latest
wails doctor
```
After you have a functioning Wails installation, just clone the launcher.
```bash
git clone https://git.bigduckie.dev/big-duckie/canvas-launcher.git
cd canvas-launcher
```
## Live Development
To run the live development mode, run `wails dev`.
To run in live development mode, run `wails dev` in the project directory. This will run a Vite development
server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser
and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect
to this in your browser, and you can call your Go code from devtools.
This sets up a Vite development server that provides hot reloads for the frontend. It also provides a backend dev server on `http://localhost:34115`. This allows you to call Go code from your browser's devtools.
## Deployment
## Building
To build this project for binary redistribution, ensure you're on your target platform. Wails *does not* reliably support cross-compilation because it relies on C binaries.
To build a redistributable, production mode package, use `wails build`.
```bash
wails build
```