Add a HACKING.asciidoc file
authorAntonio Ospite <ospite@studenti.unina.it>
Tue, 24 Jan 2012 13:55:54 +0000 (14:55 +0100)
committerAntonio Ospite <ospite@studenti.unina.it>
Wed, 25 Jan 2012 14:57:30 +0000 (15:57 +0100)
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.

HACKING.asciidoc [new file with mode: 0644]

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