mirror of
https://github.com/Grasscutters/Cultivation.git
synced 2025-12-13 15:44:35 +01:00
Update README.md
This commit is contained in:
46
README.md
46
README.md
@@ -1,10 +1,46 @@
|
|||||||
# Cultivation
|
# Cultivation
|
||||||
A custom launcher designed to easily proxy traffic from anime game to private servers.
|
A custom launcher designed to easily proxy traffic from anime game to private servers.
|
||||||
|
|
||||||
## Developer Guide
|
# Table Of Contents
|
||||||
|
|
||||||
|
* [Download](#download)
|
||||||
|
* [Developer Quickstart](#developer-quickstart)
|
||||||
|
* [Setup](#setup)
|
||||||
|
* [Building](#building)
|
||||||
|
* [Troubleshooting](#troubleshooting)
|
||||||
|
|
||||||
|
# Download
|
||||||
|
|
||||||
|
[Download the latest release here!](https://github.com/Grasscutters/Cultivation/releases)
|
||||||
|
|
||||||
|
Once downloaded, extract somewhere and open as administrator. TODO
|
||||||
|
|
||||||
|
# Developer Quickstart
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
* Install [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) & [Rust compiler](https://www.rust-lang.org/tools/install)
|
||||||
|
* `npm install` or `yarn install`
|
||||||
|
* `npm run start:dev` or `yarn start:dev`
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
`npm run build` or `yarn build`
|
||||||
|
|
||||||
|
Add `--release` or `--debug` depending on what release you are creating. This defaults to `--release`
|
||||||
|
|
||||||
|
# Troubleshooting
|
||||||
|
|
||||||
|
Idk figure it out (TODO)
|
||||||
|
|
||||||
|
# Screenshots
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* Install Cargo & Rust compiler
|
|
||||||
* `npm install`
|
|
||||||
* `yarn tauri dev`
|
|
||||||
|
|
||||||
## Work In Progress!
|
|
||||||
Reference in New Issue
Block a user