general/cppreg
2
0
Fork 0
mirror of https://github.com/sendyne/cppreg.git synced 2026-01-19 04:52:08 +00:00
Code Issues Projects Releases Wiki Activity

ADD HARDWARE AND COMPILER REQUIREMENTS TO README

Browse Source 
This closes #11.
This commit is contained in:
Nicolas Clauvelin
2018-03-21 13:05:07 -04:00
parent 819a004588
commit 203443c1f8
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -14,6 +14,15 @@ Copyright Sendyne Corp., 2010-2018. All rights reserved ([LICENSE](LICENSE)).
For a short introduction and how-to see the [quick start guide](QuickStart.md). A more complete and detailed documentation is available [here](API.md).
## Requirements ##
`cppreg` is designed to be usable on virtually any hardware that statisfies the following requirements:
* MMIO register sizes are integral numbers of bytes (*e.g.*, 8 bits, 16 bits, ...),
* registers are properly aligned: a N-bit register is aligned on a N-bit boundary,
GCC (4.8 and above) and Clang (3.3 and above) are supported and it is expected that any other C++11-compliant compiler should work (see the [quick start guide](QuickStart.md) for recommended compiler settings).
## Manifest ##
This project started when looking at this type of C code: