Skip to content

Commit 3f287f9

Browse files
committed
Add crate documentation
1 parent 819d40c commit 3f287f9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/lib.rs

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
//! Rust bindings to [avr-libc](http://www.nongnu.org/avr-libc/).
2+
//!
3+
//! When compiled with the avr-rust compiler, the libc bindings in this crate
4+
//! automatically pick up the right mcu-specific headers depending on what
5+
//! cpu is specified in the target specification file.
6+
//!
7+
//! This means that on different microcontrollers, this crate will have a different
8+
//! public API. In general, most functions are the same across all chips. Many
9+
//! constants however are device-specific.
10+
111
#![no_std]
212

313
#![allow(non_camel_case_types, non_upper_case_globals)]

0 commit comments

Comments
 (0)