Skip to content

Commit dc87cc6

Browse files
committed
doc: update docs
1 parent f1f0b6a commit dc87cc6

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
![Crates.io Version](https://img.shields.io/crates/v/wire_weaver)
44

55
<p align="center">
6-
<img src="./docs/assets/logo.png" alt="logo" width="200"/>
6+
<img src="./docs/assets/logo-shrinkwrap-256.png" alt="logo"/>
77
</p>
88

99
> WireWeaver is an API code generator for microcontrollers, supporting user-defined types, methods, properties, streams,

docs/types.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
* Discrete numbers:
55
* Signed (one-byte alignment): `i8`, `i16`, `i32`, `i64`, `i128`
66
* Unsigned (one-byte alignment): `u8`, `u16`, `u32`, `u64`, `u128`
7-
* Unsigned (four-bit alignment): `u4`
8-
* Signed and unsigned (one-bit alignment): `iN` and `uN` (`U1`, `U2`, `U3`, ... `U64`, `I2` ... `I64`)
9-
* Nibble-based variable length u32: `UNib32` (1 to 11 nibbles)
7+
* Unsigned (four-bit alignment): `nib`
8+
* Signed and unsigned (one-bit alignment): `u1`, `u2`, `u3`, ... `ub64`, `i2` ... `ib64`
9+
* `u8` is byte-aligned, while `ub8` is bit-aligned
10+
* Nibble-based variable length u32: `unib32` (1 to 11 nibbles, four-bit alignment)
1011
* Floating point numbers: `f32`, `f64`
1112
* Textual:
1213
* UTF-8 string `String`
@@ -24,12 +25,14 @@
2425
* `RefBox<T>` for self-referential types.
2526
* User-defined:
2627
* Struct
27-
* Enum with or without data variants
28-
* U1..=U63 (1-bit aligned) and unib32 discriminants.
28+
* Enum with or without data variants, multiple discriminant options:
29+
* Bit-aligned: `u1`, `u2`, ...
30+
* Nibble-aligned: `nib`
31+
* Byte-aligned: `u8`, `u16`, `u32`
32+
* Variable length `unib32`.
2933
* Tuple
3034

3135
* Not yet supported or not decided whether to support:
32-
* Tuple
3336
* Unicode character: `char` (4B)
3437
* ASCII character `c_char` (1B) (ASCII) and string: `c_str`
3538
* Map

0 commit comments

Comments
 (0)