Add a HACKING.asciidoc file

[libam7xxx.git] / HACKING.asciidoc

diff --git a/HACKING.asciidoc b/HACKING.asciidoc
new file mode 100644 (file)
index 0000000..5b2937d
--- /dev/null
+++ b/HACKING.asciidoc
@@ -0,0 +1,24 @@
+== 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
+