youwen5/jankboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'update-readme' of github.com:Team-1280/Jankboard-2 into update-readme

Browse source
This commit is contained in:
Youwen Wu 2024-03-10 00:51:26 -08:00
commit 395096742a
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -16,7 +16,7 @@ needs. It's tightly integrated with our proprietary robot features, like
collision warning and detection, and displays robot drive modes. collision warning and detection, and displays robot drive modes.
Shuffleboard, while easy to set up, lacks the fine-grained adjustments and Shuffleboard, while easy to set up, lacks the fine-grained adjustments and
customization which is afforded by a fully custom solution. The UI looks customization which are afforded by a fully custom solution. The UI looks
outdated and is quite ugly. In stark contrast, Jankboard's UI is reminiscient of outdated and is quite ugly. In stark contrast, Jankboard's UI is reminiscient of
and inspired by dashboards designed by car manufacturers, making it easy for the and inspired by dashboards designed by car manufacturers, making it easy for the
driver to get the information they need at a glance, without squinting at driver to get the information they need at a glance, without squinting at
@ -85,8 +85,9 @@ to get the development build up and running.
server for the frontend. Note that since this is basically just running the 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 `vite` development server and then connecting the Tauri webview to it, there
may be slightly inconsistent behavior in dev mode versus production mode. may be slightly inconsistent behavior in dev mode versus production mode.
5. To create a production binary, run `pnpm run tauri build`. Tauri
5. To create a production binary, run `npm run tauri build`. Tauri 6. To create a production binary, run `npm run tauri build`. Tauri
cross-compilation is still in beta, so you should generally try to build cross-compilation is still in beta, so you should generally try to build
targeting the same OS you're currently running. Check targeting the same OS you're currently running. Check
[the Tauri docs](https://tauri.app/v1/guides/building/) for more information. [the Tauri docs](https://tauri.app/v1/guides/building/) for more information.
@ -102,7 +103,7 @@ to get the development build up and running.
server. server.
- If you don't have access to a development environment that supports running - If you don't have access to a development environment that supports running
standalone executables (eg. Github Codespaces), you can try running standalone executables (eg. Github Codespaces), you can try running
`npm run dev` instead of `npm run tauri dev`, which will open a development `pnpm run dev` instead of `pnpm run tauri dev`, which will open a development
server at `localhost:5173` with the frontend running in the web. However, app server at `localhost:5173` with the frontend running in the web. However, app
behavior may be inconsistent and you will not get any features from the Rust behavior may be inconsistent and you will not get any features from the Rust
backend. backend.