Skip to content
Snippets Groups Projects
Commit 920af22a authored by Federico Lolli's avatar Federico Lolli
Browse files

added documentation

parents
No related branches found
No related tags found
No related merge requests found
requirements:
- MUST have a blocking reading
- MUST provide a baud rate options
- MUST have a blocking reading
- SHOULD provide a interface with method for open, close, read, write
- SHOULD provide the same interface of actual serial_bridge C++ implementation
- MAY use the creates `serial` and `rust_mex`
- MAY implent a multithread approach (concurrent read for different ports)
#import "functions.typ": requirements_table
// ====== DATA ======
#let data = yaml("data.yml")
#show "MUST": strong
#show "MUST NOT": strong
#show "SHOULD": strong
#show "SHOULD NOT": strong
#show "MAY": strong
// ====== CONTENT ======
= Requirements
Follow the requirements.
#requirements_table(data.requirements)
= Design
- state machine?
// === FUNCTIONS ===
#let requirements_table(requirements) = {
let reqs = ();
for (i, req) in requirements.enumerate() {
reqs.push([*R#(i+1)*])
reqs.push(eval(req, mode: "markup"))
}
table(
columns: (auto, 1fr),
align: (center, left),
[*ID*], [*Description*],
..reqs,
)
}
source := 'documentation.typ'
dest := 'documentation.pdf'
default:
typst watch {{source}} {{dest}} --open
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment