mirror of
https://github.com/supleed2/svd2cpp.git
synced 2024-12-22 13:45:50 +00:00
Create README.md
This commit is contained in:
parent
e5a651fede
commit
16e52665c7
18
README.md
Normal file
18
README.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# svd2cpp
|
||||||
|
Zero-cost abstraction register library generator.
|
||||||
|
## What is *svd2cpp*?
|
||||||
|
*svd2cpp* is a generator that parses .svd files provided by ARM chip vendor.
|
||||||
|
It generates header file that allows for reading and writing to microcontroller's registers with zero overhead.
|
||||||
|
|
||||||
|
## How to get *svd2cpp*?
|
||||||
|
Download source code and compile it. Note that this repo uses submodules thus do not forget to `git submodule init` and `git submodule update` after cloning.
|
||||||
|
|
||||||
|
OR
|
||||||
|
|
||||||
|
Download precompiled parser.
|
||||||
|
|
||||||
|
## How to use *svd2cpp*?
|
||||||
|
That's super easy:
|
||||||
|
```console
|
||||||
|
./svd2cpp -i svdFile.svd -o generatedHeader.hpp
|
||||||
|
```
|
Loading…
Reference in a new issue