Update README according to the current API
[gram.git] / libgram / README.md
1 # libgram, the C companion for gram
2
3 libgram is the C library for gram core initialization.
4
5 ## HowTo
6
7 Build libgram with make. In your firmware:
8
9 ```C
10 #include <gram.h>
11
12 int main(void) {
13 struct gramCtx ctx;
14 int err = gram_init(&ctx, 0x10000000, 0x00006000, 0x00005000);
15
16 return 0;
17 }
18 ```
19
20 Link it to this library and you should be good to go!
21
22 ## Error handling
23
24 ```
25 GRAM_ERR_NONE: No error happened (hardcoded to zero)
26 GRAM_ERR_UNDOCUMENTED: Undocumented error, shame on us lazy coders (take a look at the code)
27 ```