Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/content/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ The V5 Brain is an *embedded platform*, meaning the code that you write runs wit

![ferris standing next to some crates](/docs/crates.svg)

Rust is a modern language that is growing in popularity every year. It has many applications, from networking to embedded systems. If you've been looking for a chance to learn and use it in a project also enjoy robotics, then vexide is the perfect opportunity for you to pick it up! vexide's API takes heavy inspiration from widely used packages such as [`tokio`](https://crates.io/crates/tokio), [`embassy`](https://embassy.dev/), and [`cortex-m`](https://github.com/rust-embedded/cortex-m), offering you a realistic look into the embedded and async Rust ecosystem.
Rust is a modern language that is growing in popularity every year. It has many applications, from networking to embedded systems. If you've been looking for a chance to learn and use it in a project while also enjoying robotics, then vexide is the perfect opportunity for you to pick it up! vexide's API takes heavy inspiration from widely used packages such as [`tokio`](https://crates.io/crates/tokio), [`embassy`](https://embassy.dev/), and [`cortex-m`](https://github.com/rust-embedded/cortex-m), offering you a realistic look into the embedded and async Rust ecosystem.

vexide projects are just regular Rust projects. By using vexide, you gain full access to the entirety of the [crates.io](https://crates.io/) ecosystem's 150,000+ packages to use in your code. [Cargo](https://doc.rust-lang.org/cargo/), Rust's package manager makes it extremely easy to install third-party dependencies and integrate them into your code. In fact, `vexide` itself is just a regular library that's installed through Cargo!
vexide projects are just regular Rust projects. By using vexide, you gain full access to the entirety of the [crates.io](https://crates.io/) ecosystem's 150,000+ packages to use in your code[^1]. [Cargo](https://doc.rust-lang.org/cargo/), Rust's package manager makes it extremely easy to install third-party dependencies and integrate them into your code. In fact, `vexide` itself is just a regular library that's installed through Cargo!

[^1]: Not all Cargo crates can be used in embedded contexts. Look for crates with the `no_std` attribute.

## Safety, Predictability, and Fault Tolerance

Expand Down Expand Up @@ -61,4 +63,4 @@ vexide's development is entirely community-driven, meaning it is not maintained

vexide's goal regarding hardware is to support as many devices as possible with as much functionality as possible while providing consistent and reliable interfaces for programmers. For example, vexide provides support for many rarely-used legacy sensors and the [V5 Electromagnet](https://docs.rs/vexide-devices/latest/vexide_devices/smart/electromagnet/struct.Electromagnet.html), despite it being illegal in competition use.

We also aim to be as consistently well-documented as possible. Our [API reference](https://docs.rs/vexide) contains detailed descriptions and examples of every type, function, and constant you can use. In some cases, vexide's documentation can be more detailed than official documentation. Information has been collected from multiple sources, including the [BLRS Wiki](https://wiki.purduesigbots.com/), first-party testing, and fragmented sources such as comments made on [VEXforum](https://www.vexforum.com/).
We also aim to be as consistently well-documented as possible. Our [API reference](https://docs.rs/vexide) contains detailed descriptions and examples of every type, function, and constant you can use. In some cases, vexide's documentation can be more detailed than official documentation. Information has been collected from multiple sources, including the [BLRS Wiki](https://wiki.purduesigbots.com/), first-party testing, and fragmented sources such as comments made on [VEXforum](https://www.vexforum.com/).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did I remove a newline or something?