From 174e125f1c9542d39a5f78d909335ff5013aec2d Mon Sep 17 00:00:00 2001 From: SpikeHD Date: Sat, 11 Jun 2022 19:22:48 -0700 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 528bed4..2e27da0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,46 @@ # Cultivation 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 + +![image](https://user-images.githubusercontent.com/25207995/173211603-e5e85df7-7fd3-430b-9246-749ebbc1e483.png) +![image](https://user-images.githubusercontent.com/25207995/173211543-b7e88943-cfd2-418b-ac48-7f856868129b.png) +![image](https://user-images.githubusercontent.com/25207995/173211561-a1778fdc-5cfe-4687-9a00-44500d29e470.png) +![image](https://user-images.githubusercontent.com/25207995/173211573-8cedfa9a-51c9-4670-a4f7-a334a2fabec5.png) +![image](https://user-images.githubusercontent.com/25207995/173211590-6a2242b5-1e8f-4db9-a5c7-06284688b131.png) + + -* Install Cargo & Rust compiler -* `npm install` -* `yarn tauri dev` -## Work In Progress! \ No newline at end of file