commit 7b1217ddc959ba1b6d00d9afb0a126a41b562cac
parent 29d88e396d6b7a1a97c85e0fbf001eb20721a4bb
Author: finwo <finwo@pm.me>
Date: Wed, 15 Aug 2018 11:07:44 +0200
Added README
Diffstat:
1 file changed, 23 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# TrackThis Code Style Guides
+
+Most open-source projects have their own common code style, whether documented
+or not. A style guide is a set of (sometimes arbitary) conventions about how to
+write code for those projects. It is much easier to understand a large codebase
+when all the code in it is in a consistent style.
+
+"Style" covers a lot of ground, from "use camelCase for variable names" to
+"never use global variables" to "never use exceptions." This project
+([trackthis/styleguide](https://github.com/trackthis/styleguide)) links to the
+style guidelines we use for TrackThis code. If you are modifying a project that
+is to be included in, or originated at, TrackThis, you may be pointed to this
+page to see the style guides that apply to that project.
+
+This project aims to cover all grounds of the languages used within trackthis
+and to provide tools to enforce the guide. A list of languages included in this
+guide can be found below.
+
+The style guides in this project are licensed under the CC-By 4.0 License,
+which encourages you to share these documents. See
+https://creativecommons.org/licenses/by/4.0/ for more details.
+
+<a rel="license" href="https://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a>
