diff --git a/site/index.html b/site/index.html index 2ad256b..ca8b198 100644 --- a/site/index.html +++ b/site/index.html @@ -350,8 +350,8 @@ on my list for that:
indent(1)
instead.indent(1)
instead.anoncvs
account is just anoncvs
.-Telodendria's code style is very unique. In general, these are -the conventions used by the code base. +In general, these are the conventions used by the code base. This +guide may be slightly outdated or subject to change, however. The +source code itself is the absolute source of truth, so as long as +you make your code look like the code surrounding it, you should +be fine.
enum
s and struct
s are always
typedef
-ed to their same name. The typedef
occurs in the public API header, and the actual declaration occurs in
-the private implementation header.
+the implementation file.
expand
. A unit of indentation
-is 4 spaces.
+A feature of the code base lives in a single .c
file that
+has a matching header file. The header file should only export public
+symbols, everything else in the .c
file should be
+static
.
vi(1)
in an 80x24 terminal to write code.
+Anywhere curly braces are optional, there must still be curly braces.
+This makes it easy to add on to the code later, and just makes things
+less ambiguous.
-This guide may be subject to change. The source code is the absolute
-source of truth, so as long as you make your code look like the
-code surrounding it, you should be fine.
+As far as actually formatting the code goes, such as where to put
+brackets and whether you use tabs or spaces, use indent(1)
+to take care of all of that. The root of the repository has a
+.indent.pro
file that should automatically be loaded by
+indent(1)
to set the correct rules. If you don't have
+access to a working indent(1)
, just indicate in your patch
+that I should run indent(1)
on the code after applying it.
+I'll likely run my indent(1)
on the code anyway though,
+just to make sure the spacing is consistent, if nothing else.