Skip to content

Commit

Permalink
Add link to new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SebastienGllmt authored Jul 12, 2023
1 parent f6b780b commit 8992d81
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Experimental library for generating rust code for CBOR serialization from CDDL specs.
# Library to generate Rust and WASM code from CDDL specifications

See docs [here](https://dcspark.github.io/cddl-codegen/)

# Old docs (deprecated)

### Purpose ###

Expand Down Expand Up @@ -177,4 +181,4 @@ bar = [
]
```
This will treat `Foo` as a type that will exist and that has implemented the `Serialize` and `Deserialize` traits, so the (de)serialization logic in `Bar` here will call `Foo::serialize()` and `Foo::deserialize()`.
This can also be useful when you have a spec that is either very awkward to use (so you hand-write or hand-modify after generation) in some type so you don't generate those types and instead manually merge those hand-written/hand-modified structs back in to the code afterwards. This saves you from having to manually remove all code that is generated regarding `Foo` first before merging in your own.
This can also be useful when you have a spec that is either very awkward to use (so you hand-write or hand-modify after generation) in some type so you don't generate those types and instead manually merge those hand-written/hand-modified structs back in to the code afterwards. This saves you from having to manually remove all code that is generated regarding `Foo` first before merging in your own.

0 comments on commit 8992d81

Please sign in to comment.