From 05d33ff0f45fce64889b18bc95818fe1610839ad Mon Sep 17 00:00:00 2001
From: Bjørn Lindeijer <bjorn@lindeijer.nl>
Date: Sat, 11 Dec 2004 19:32:55 +0000
Subject: Added HACKING.txt and reverted the revertion of my changes to log.cpp
 ;)

---
 docs/HACKING.txt | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 docs/HACKING.txt

(limited to 'docs/HACKING.txt')

diff --git a/docs/HACKING.txt b/docs/HACKING.txt
new file mode 100644
index 00000000..ba080f0f
--- /dev/null
+++ b/docs/HACKING.txt
@@ -0,0 +1,36 @@
+----------------------------
+The Mana World Hacking Guide
+----------------------------
+
+With multiple coders working on the same source files, there needs to be a
+standard specifying how code is written down. Not doing so can cause quite some
+annoyance for certain coders and easily creates more version conflicts than
+necessary.
+
+* Code is indented using 4 spaces, no tabs.
+
+* Control constructs like this:
+
+  if (condition) {
+  }
+
+  for (init; condition; step) {
+  }
+
+  while (condition) {
+  }
+
+  /*
+   * Documentation about behaviour
+   */
+  void function(param1, param2) {
+  }
+
+  Ending parenthesis may be on next line for clarity.
+
+* Use of whitespace example:
+
+  x = ((5 + 4) * 3) / 1.5;
+
+* Agreement on function/class/variable/method/member naming pending.
+
-- 
cgit v1.2.3-70-g09d2