Update documenatation
parent
0b77b069a4
commit
bbdecdb6f7
15
README.md
15
README.md
|
|
@ -60,24 +60,15 @@ They are also called A and B, but you shouldn't get confused and mix it with the
|
|||
|
||||
## TODO's
|
||||
|
||||
- [ ] add more examples (e.g. for f3)
|
||||
- [ ] improve the partial drawing/check the timings/timing improvements/....
|
||||
- [ ] for later: add support for the smaller waveshare epds
|
||||
- [ ] for later: add support for more waveshare epds
|
||||
- [ ] License: Stay with ISC (=MIT) or go to the Apache+MIT Dual License as used in many other projects?
|
||||
|
||||
## Graphics/Drawing
|
||||
|
||||
Supports:
|
||||
- Lines
|
||||
- Squares
|
||||
- Circles
|
||||
- Pixels
|
||||
- Chars
|
||||
- Strings
|
||||
It is recommended to use the [embedded graphics](https://crates.io/crates/embedded-graphics) library.
|
||||
|
||||
Chars and Strings work with a 8x8-Font.
|
||||
|
||||
Support for bigger sized/independent Fonts is in work.
|
||||
Even though any u8-slice works, it is not recommended!
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -55,13 +55,8 @@ impl<'a> InputPin for HackInputPin<'a> {
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
*
|
||||
* BE CAREFUL: this wasn't tested yet, and the pins are also not choosen correctly (just some random ones atm)
|
||||
*
|
||||
*/
|
||||
|
||||
//TODO: Test this implemenation
|
||||
//BE CAREFUL: this wasn't tested yet
|
||||
fn main() {
|
||||
|
||||
run().unwrap();
|
||||
|
|
|
|||
|
|
@ -51,8 +51,6 @@ impl<'a> HackInputPin<'a> {
|
|||
}
|
||||
}
|
||||
|
||||
//TODO: make it safer?? or handle the errors better?
|
||||
// now it defaults to is_low if an error appears
|
||||
impl<'a> InputPin for HackInputPin<'a> {
|
||||
fn is_low(&self) -> bool {
|
||||
self.pin.get_value().unwrap_or(0) == 0
|
||||
|
|
@ -64,11 +62,7 @@ impl<'a> InputPin for HackInputPin<'a> {
|
|||
}
|
||||
|
||||
|
||||
/*
|
||||
*
|
||||
* BE CAREFUL: this wasn't tested yet, and the pins are also not choosen correctly (just some random ones atm)
|
||||
*
|
||||
*/
|
||||
|
||||
fn main() {
|
||||
run().map_err(|e| println!("{}", e.to_string())).unwrap();
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue