Skip to content

Commit 89f0c16

Browse files
authored
docs(s2n-events): Update s2n-events docs with generate script info (#2797)
1 parent d35c22f commit 89f0c16

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

tools/generate-events/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
# generate-events
3+
4+
This crate generates the events systems for s2n-quic/s2n-quic-dc using `s2n-events`. See the [s2n-events](../s2n-events) crate for more details.

tools/s2n-events/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# s2n-events
22

3-
This crate generates all of the boilerplate for event types and traits.
3+
This crate implements the code generation for boilerplate event types and traits.
4+
5+
s2n-events is a library which exposes functionality to generate an events system according to project-specific configuration options. s2n-events should be consumed by an event generation program within a given project. For example, see the [event-generator](../event-generator) crate which generates the s2n-quic/s2n-quic-dc events systems.
46

57
## Features
68

79
* A single rust file is generated for all of the event handling code.
8-
* The generator script is executed at commit time, which provides minimal compilation overhead.
10+
* Project-owned generator scripts can be executed at commit time, which provides minimal compilation overhead.
911
* The output can be easily read and audited.
1012
* IDEs can easily read the generated code and provide autocompletion on events.
1113

0 commit comments

Comments
 (0)