Update README.md

This commit is contained in:
Max Känner 2023-01-29 15:20:58 +00:00
parent b01c8b2daf
commit adf731dd29

View File

@ -1,12 +1,6 @@
# Template for ev3dev-lang-rust
# EV3 Line follower using ev3dev-lang-rust
This is a template for creating and building projects with [`ev3dev-lang-rust`](https://github.com/pixix4/ev3dev-lang-rust). It contains all the necessary files to cross compile the "Hello World" example for ev3dev platform.
## Dependencies
- `cargo`
- `docker`
- `make` (optional)
This program follows a line using a PID controller.
## Setup
@ -16,6 +10,8 @@ Install the `armv5te-musl` toolchain
rustup target add armv5te-unknown-linux-musleabi
```
The robot needs exactly two large motors and exactly one color sensor.
## Usage
Build this project:
@ -26,10 +22,8 @@ cargo build --release
The resulting binary can be found at `./target/armv5te-unknown-linux-musleabi/release/<ARTIFACT>`.
Optionally strip the executable to reduce binary size:
Alternatively use the provided script to build and upload the binary to the robot using ssh:
```bash
make strip
# or
docker run --rm -v $(PWD):/build -w /build pixix4/ev3dev-rust:latest arm-linux-gnueabi-strip /build/target/armv5te-unknown-linux-musleabi/release/<ARTIFACT>
./upload.sh
```