README.md
1# PL011 QEMU Device Model
2
3This library implements a device model for the PrimeCell® UART (PL011)
4device in QEMU.
5
6## Build static lib
7
8Host build target must be explicitly specified:
9
10```sh
11cargo build --target x86_64-unknown-linux-gnu
12```
13
14Replace host target triplet if necessary.
15
16## Generate Rust documentation
17
18To generate docs for this crate, including private items:
19
20```sh
21cargo doc --no-deps --document-private-items --target x86_64-unknown-linux-gnu
22```
23
24To include direct dependencies like `bilge` (bitmaps for register types):
25
26```sh
27cargo tree --depth 1 -e normal --prefix none \
28 | cut -d' ' -f1 \
29 | xargs printf -- '-p %s\n' \
30 | xargs cargo doc --no-deps --document-private-items --target x86_64-unknown-linux-gnu
31```
32