diff --git a/README.md b/README.md index cff8ea7..7a163a2 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,31 @@ That's super easy: ```console ./svd2cpp -i svdFile.svd -o generatedHeader.hpp ``` + +## How to use generated header? +After including header in your code, you can use all features such as *set*, *reset*, *read*. + +Syntax is quite simple and easy to use: +```cpp +operation(); +``` +###Examples: +Set bit UE(USART enable) in USART1 Control Register 1 +```cpp +set(); +``` + +Reset bit UE(USART enable) in USART1 Control Register 1 +```cpp +reset(); +``` + +Read Channel 1 Transfer Complete flag in DMA1 ISR Register +```cpp +bool transferComplete = read(); +``` + +Set Memory address for DMA1 channel 2 +```cpp +set(0xDEADBEEF); +```