From adf731dd29ff110dc6e78011a8ebe2498a8ddd4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20K=C3=A4nner?= Date: Sun, 29 Jan 2023 15:20:58 +0000 Subject: [PATCH] Update README.md --- README.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2cddc82..54c4cf0 100644 --- a/README.md +++ b/README.md @@ -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/`. -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/ +./upload.sh ```