Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sickeroni authored Aug 27, 2016
1 parent 633c2be commit 9e30f78
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Kvasir introduces a seam right above the bare metal in a zero cost manner using

# Getting started with Kvasir
We took great care to reduce dependencies, therefore Kvasir should be easy to add to an existing embedded project. To use the library simply pull the folder Lib from this repository and add it to your compilers include paths (-I directive). Be sure and set your compiler dialect to C++11 at least. It is also recommended to set optimization to -Og rather than -O0 in order to get smaller yet debugable binaries. Thats it, you're ready to go.
`-I$(PathtoKvasir)/Lib/ -Og -std=c++11`
`-I<PathToKvasir>/Lib/ -Og -std=c++11`

# Basic concepts
In Kvasir we view registers as tuples of BitFields, which are accessible to the user, and reserved bits which are not. The type of a BitField is not always int, as is common practice in the embedded domain, rather it is often a strongly classed enum where it is more fitting. The bool type also often represents single bits.
Expand Down

0 comments on commit 9e30f78

Please sign in to comment.