Merge branch 'style' into 'master'

Style

subject to change as we notice things that the config does not actually specify and want coded.

See merge request !10

license

+The MIT License (MIT)
+
+Copyright (c) 2015 Adam Freeman, Malcolm Lorber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

style.cfg

+#
+#  Allman style
+#
+
+indent_with_tabs		= 0		# 1=indent to level only, 2=indent with tabs
+input_tab_size			= 4		# original tab size
+output_tab_size			= 4		# new tab size
+indent_columns			= output_tab_size
+
+# brace settings
+nl_assign_brace			= add		# "= {" vs "= \n {"
+nl_enum_brace			= add		# "enum {" vs "enum \n {"
+nl_union_brace			= add		# "union {" vs "union \n {"
+nl_struct_brace			= add		# "struct {" vs "struct \n {"
+nl_do_brace			= add		# "do {" vs "do \n {"
+nl_if_brace			= add		# "if () {" vs "if () \n {"
+nl_for_brace			= add		# "for () {" vs "for () \n {"
+nl_else_brace			= add		# "else {" vs "else \n {"
+nl_while_brace			= add		# "while () {" vs "while () \n {"
+nl_switch_brace			= add		# "switch () {" vs "switch () \n {"
+nl_fcall_brace			= add		# "foo() {" vs "foo()\n{"
+nl_fdef_brace			= add		# "int foo() {" vs "int foo()\n{"
+nl_brace_while			= remove
+nl_brace_else			= add
+
+# Spacing settings
+sp_func_def_paren		= remove	# "int foo (){" vs "int foo(){"
+sp_func_call_paren		= remove	# "foo (" vs "foo("
+sp_func_proto_paren		= remove	# "int foo ();" vs "int foo();"
+sp_return_paren			= add		# "return (1);" vs "return(1);"
+sp_sizeof_paren			= remove	# "sizeof (int)" vs "sizeof(int)"
+sp_before_sparen		= force 	# "if (" vs "if("
+
+# Should be obvious
+sp_assign			= force
+sp_arith			= force
+sp_bool				= force
+sp_compare			= force
+sp_after_comma			= force
\ No newline at end of file

style.md

+Style Guidelines
+----------------
+
+For all things regarding whitespace, run code through uncrustify using
+
+```shell
+uncrustify -c style.cfg -f <source_file>
+```
+
+and refer to style.cfg for specifications.
+
+
+Naming Conventions
+==================
+
+Use lowercase underscore (snake_case) for both function names and variable names.
+
+For preprocessor constants defines, use all uppercase letters, with
+underscores between words.