add some instruction in readme
This commit is contained in:
30
Readme.md
Normal file
30
Readme.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Deckui
|
||||
|
||||
Attempt at a customizable GUI to control some aspect of your computer via a remote device (i.e. SBC with touchscreen).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* Have rust installed see [rustup](https://rustup.rs)
|
||||
|
||||
|
||||
## Build an Run
|
||||
|
||||
### If you have cargo-watch and runcc installed
|
||||
|
||||
* You can just run :
|
||||
```sh
|
||||
cargo runcc -c runcc.yml
|
||||
```
|
||||
Take a look at rock64.yml to run the ui on a remote device during developpement
|
||||
|
||||
### In all case
|
||||
|
||||
* Run the app/server
|
||||
|
||||
```sh
|
||||
cargo run -p app
|
||||
```
|
||||
* Run the remote
|
||||
```sh
|
||||
cargo run -p remote
|
||||
```
|
||||
Reference in New Issue
Block a user