summary |
shortlog |
log |
commit | commitdiff |
tree
raw |
patch |
inline | side by side (from parent 1:
5e7d217)
Give some info about how to make a debug build and mention the coding
style used in the project, so new contributors know how to behave.
--- /dev/null
+== Hacking libam7xxx
+
+=== Coding style
+
+libam7xxx uses the linux kernel coding style:
+http://kernel.org/doc/Documentation/CodingStyle
+
+=== Debug builds
+
+The suggested way to hack on the project is:
+
+ $ mkdir build
+ $ cd build
+ $ cmake ../ -DCMAKE_BUILD_TYPE=debug
+ $ make
+
+If you want to check the code with the ''sparse'' static analysis tool you
+can run:
+
+ $ mkdir build
+ $ cd build
+ $ cmake ../ -DCMAKE_C_COMPILER=cgcc
+ $ make
+