From 82a95b823791494df21c1d946ef07dc41394a82a Mon Sep 17 00:00:00 2001 From: Rahix Date: Fri, 10 May 2019 22:49:06 +0200 Subject: [PATCH] Update README Signed-off-by: Rahix --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 81de38a..41efeed 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,10 @@ Via the feature you can select which chip you want the register specifications f * `attiny85` ## Internals -*avr-device* is generated using [`atdf2svd`](https://github.com/Rahix/atdf2svd) and [`svd2rust`](https://github.com/rust-embedded/svd2rust). The vendor-provided *atdf* files can be found in `vendor/`. Later on, we intend to add support for patching the svd files because some information from the provided atdfs is not quite as good as it should be (mainly undescriptive names and missing descriptions). +*avr-device* is generated using [`atdf2svd`](https://github.com/Rahix/atdf2svd) and [`svd2rust`](https://github.com/rust-embedded/svd2rust). The vendor-provided *atdf* files can be found in `vendor/`. Later on, we intend to add support for patching the svd files because some information in the provided files is not quite as good as it should be (mainly undescriptive names and missing descriptions). + +### Adding a new Chip +To add a new chip, download the *atdf* from and place it in `vendor/`. Be sure to name it like the Rust module that should be generated. Next, you need to integrate it into the base crate and build system. Follow what was done in [this commit](https://github.com/Rahix/avr-device/commit/8b1679a89704f5a303a1578b261aa2aee53e1251). Please adhere to the alphabetical sorting that is present so far. ## License *avr-device* is licensed under either of -- 2.48.1