mirror of
https://github.com/Grasscutters/Cultivation.git
synced 2025-12-13 07:34:36 +01:00
feat: the great purge
This commit is contained in:
23
README.md
23
README.md
@@ -75,37 +75,37 @@ Please allow the Cultivation window to pop back up once you have quit out of the
|
||||
|
||||
### Setup
|
||||
|
||||
- Install [NodeJS >12](https://nodejs.org/en/)
|
||||
- Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install) (cry about it `npm` lovers)
|
||||
- Install [NodeJS >18](https://nodejs.org/en/)
|
||||
- Install [pnpm](https://pnpm.io/installation) (cry about it `yarn` lovers)
|
||||
- Install [Rust](https://www.rust-lang.org/tools/install)
|
||||
- `yarn install`
|
||||
- `yarn tauri dev`
|
||||
- `pnpm install`
|
||||
- `pnpm tauri dev`
|
||||
|
||||
### Building
|
||||
|
||||
For a release build,
|
||||
|
||||
- `yarn build`
|
||||
- `pnpm build`
|
||||
|
||||
For a debug build,
|
||||
|
||||
- `yarn build --debug`
|
||||
- `pnpm build --debug`
|
||||
|
||||
### Code Formatting and Linting
|
||||
|
||||
Formatting:
|
||||
|
||||
- `yarn format`
|
||||
- `pnpm format`
|
||||
|
||||
Check Lints, fix (some) lints:
|
||||
|
||||
- `yarn lint`, `yarn lint:fix`
|
||||
- `pnpm lint`, `pnpm lint:fix`
|
||||
|
||||
### 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.
|
||||
- `yarn build`
|
||||
- `pnpm build`
|
||||
|
||||
The update will be at `src-tauri/target/(release|debug)/msi/Cultivation_X.X.X_x64_xx-XX.msi.zip`
|
||||
|
||||
@@ -115,10 +115,7 @@ A full theming reference can be found [here!](/THEMES.md)
|
||||
|
||||
# Screenshots
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
TODO
|
||||
|
||||
## Credits
|
||||
|
||||
|
||||
Reference in New Issue
Block a user