Clean up readme

This commit is contained in:
Brian Bowman 2022-07-18 17:42:27 -05:00
parent 4ff9e88185
commit adbb8e380d

View File

@ -1,4 +1,4 @@
# Cient Patching Notice
# Client Patching Notice
For game versions 2.8 and above, Cultivation automatically makes a small patch to your game client when launching using Grasscutter, and restores it upon closing the game. In theory, you should still be totally safe, however it would be dishonest to not explicitly state that **modifying the game client could, theoretically, lead to a ban if you connect to official servers with it**. It is extremely unlikely AND there are no instances known of it happening, but the possibility exists.
# Cultivation
@ -12,8 +12,12 @@ Please do **NOT install, download, or use pre-compiled versions of Cultivation f
* [Developer Quick-start](#developer-quickstart)
* [Setup](#setup)
* [Building](#building)
* [Troubleshooting](#troubleshooting)
* [Code Formatting and Linting](#code-formatting-and-linting)
* [Generating Update Artifacts](#generating-update-artifacts)
* [Theming](#theming)
* [Screenshots](#screenshots)
* [Credits](#credits)
# Download
[Find release builds here!](https://github.com/Grasscutters/Cultivation/releases)
@ -24,28 +28,28 @@ Once downloaded, extract somewhere and open as administrator.
### Setup
* Install [NodeJS >12](https://nodejs.org/en/)
* Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) (cry about it `npm` lovers)
* Install [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) & [Rust compiler](https://www.rust-lang.org/tools/install)
* Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install) (cry about it `npm` lovers)
* Install [Rust](https://www.rust-lang.org/tools/install)
* `yarn install`
* `yarn start:dev`
### Building
`npm run build` or `yarn build`
For a release build,
- `yarn build`
Add `--release` or `--debug` depending on what release you are creating. This defaults to `--release`
For a debug build,
- `yarn build --debug`
### Code Formatting and Linting
- `yarn format`
- `yarn lint`
Format the code with `npm format` or `yarn format`. Run the lints with `npm lint` or `yarn lint`.
### Updating
### Generating Update Artifacts
* Add the `TAURI_PRIVATE_KEY` as an environment variable with a path to your private key.
* Add the `TAURI_KEY_PASSWORD` as an environment variable with the password for your private key.
* Run `npm run update` or `yarn build`
* The update will be in `src-tauri/target/(release|debug)/msi/Cultivation_X.X.X_x64_xx-XX.msi.zip`
* `yarn build`
# Troubleshooting
TODO. Collect common issues before updating.
The update will be at `src-tauri/target/(release|debug)/msi/Cultivation_X.X.X_x64_xx-XX.msi.zip`
# Theming