From d26287fd08622a31b0d79379e981fb6bed132678 Mon Sep 17 00:00:00 2001
From: AES <josiphaboic@gmail.com>
Date: Mon, 20 Sep 2021 18:57:03 +0200
Subject: [PATCH] Create README.md

---
 README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d362859
--- /dev/null
+++ b/README.md
@@ -0,0 +1,72 @@
+# bytex - 8bit no_std helper functions
+
+## bytex::repr
+
+``` rust
+let x: u8 = 0b1000_0010;
+assert_eq!(['0','b','1','0','0','0','0','0','1','0'], bytex::repr(x));
+```
+
+## bytex::bit
+
+### bytex::bit::get
+
+``` rust
+let x: u8 = 0b0000_0001;
+let y: u8 = bytex::bit::get(x, 0);
+assert_eq!(y, 1);
+```
+
+### bytex::bit::set
+
+``` rust
+let mut x: u8 = 0b0000_0000;
+bytex::bit::set(&mut x, 0);
+assert_eq!(x, 0b0000_0001);
+```
+
+### bytex::bit::unset
+
+``` rust
+let mut x: u8 = 0b0000_0001;
+bytex::bit::unset(&mut x, 0);
+assert_eq!(x, 0b0000_0000);
+```
+
+### bytex::bit::toggle
+
+``` rust
+let mut x: u8 = 0b0000_0001;
+bytex::bit::toggle(&mut x, 0);
+assert_eq!(x, 0b0000_0000);
+```
+
+### bytex::bit::as_char
+
+``` rust
+let x: u8 = 0b0000_0001;
+let y: char = bytex::bit::as_char(x, 0);
+assert_eq!(y, '1');
+```
+
+## bytex::register
+
+### bytex::register::write
+
+``` rust
+use bytex::bit::set;
+use bytex::register::{read, write};
+
+const DDRD: *mut u8 = 0x2A as *mut u8;
+const DDRD0: u8 = 0;
+write(DDRD, set(&mut read(DDRD), DDRD0));
+```
+
+### bytex::register::read
+
+``` rust
+use bytex::register::{read};
+
+const DDRD: *mut u8 = 0x2A as *mut u8;
+let ddrd = read(DDRD);
+```