From 1974ea56039bdd045361ee18833a637e1e06f434 Mon Sep 17 00:00:00 2001 From: Youwen Wu Date: Sun, 10 Mar 2024 00:50:12 -0800 Subject: [PATCH] style: fix ordered list spacing --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 1c71551..2a74bab 100644 --- a/README.md +++ b/README.md @@ -70,12 +70,14 @@ to get the development build up and running. 1. Clone the repository. The `client` folder contains the vast majority of the source code for the desktop app. + 2. `cd` into the `client` folder. The configuration files and `package.json`, This is where stuff like `package.json` and configuration files for our various tooling are housed. The `client/src-tauri` directory contains the Rust source code and `cargo` configuration files for the backend that interfaces with the robot via Network Tables. 3. Run `pnpm install` to install dependencies. + 4. To run the desktop app in developer mode (with automatic hot stateful reload and other useful features like error reporting), make sure you're in the `client` directory and run `pnpm run tauri dev`. This will install and build @@ -83,6 +85,7 @@ to get the development build up and running. server for the frontend. Note that since this is basically just running the `vite` development server and then connecting the Tauri webview to it, there may be slightly inconsistent behavior in dev mode versus production mode. + 5. To create a production binary, run `npm run tauri build`. Tauri cross-compilation is still in beta, so you should generally try to build targeting the same OS you're currently running. Check