mirror of
https://github.com/bybrooklyn/openbitdo.git
synced 2026-03-19 04:12:56 -04:00
Bootstrap OpenBitdo clean-room SDK and reliability milestone
This commit is contained in:
30
sdk/README.md
Normal file
30
sdk/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# OpenBitdo SDK
|
||||
|
||||
`bitdo_proto` and `bitdoctl` provide the clean-room protocol core and CLI.
|
||||
|
||||
## Build
|
||||
```bash
|
||||
cargo build --workspace
|
||||
```
|
||||
|
||||
## Test
|
||||
```bash
|
||||
cargo test --workspace --all-targets
|
||||
```
|
||||
|
||||
## Guard
|
||||
```bash
|
||||
./scripts/cleanroom_guard.sh
|
||||
```
|
||||
|
||||
## Hardware smoke report
|
||||
```bash
|
||||
./scripts/run_hardware_smoke.sh
|
||||
```
|
||||
|
||||
## CLI examples
|
||||
```bash
|
||||
cargo run -p bitdoctl -- --mock list
|
||||
cargo run -p bitdoctl -- --mock --json --pid 24585 identify
|
||||
cargo run -p bitdoctl -- --mock --json --pid 24585 diag probe
|
||||
```
|
||||
Reference in New Issue
Block a user