Skip to content

Commit 2167a2f

Browse files
committed
Update readme
1 parent f975659 commit 2167a2f

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# Robotrs
22

33
A port of WPILib and REVLib to Rust for use in the FIRST Robotics Competition.
4+
This project intends to investigate the use of Rust to prevent simple logic
5+
errors like commanding a subsystem of the robot to do two seperate things at
6+
the same time by using the borrow checker. This project also experiments with
7+
allowing parts of the robotrs ecosystem to be used outside of FRC. This also
8+
aims to make it easier for teams to use shared code by using cargo instead of
9+
gradle and a custom dependency managment system.
410

511
## Security
612

7-
The `hal-sys`, `ctre`, and `revlib` packages all generate bindings to C
8-
libraries at compile time. The headers to these libraries and the binaries
9-
themselves are automatically downloaded at compile time. All code related to
10-
the downloading of these libs can be found in the `build-utils` crate and the
11-
`build.rs` of the 3 crates mentioned earlier.
13+
The `hal-sys`, `ctre`, `nt`, and `revlib` packages all download libraries and the
14+
binaries necessary at compile time. All code related to the downloading of
15+
these libs can be found in the `build-system` directory and the `build.rs` of the 4
16+
crates mentioned earlier.
1217

1318
## Not affilited with or supported by WPILib, REV Robotics, CTRE, or FIRST
1419

0 commit comments

Comments
 (0)