aboutsummaryrefslogtreecommitdiff
path: root/docs/cpp-coding/01-Preface.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cpp-coding/01-Preface.md')
-rw-r--r--docs/cpp-coding/01-Preface.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/cpp-coding/01-Preface.md b/docs/cpp-coding/01-Preface.md
new file mode 100644
index 000000000..fac2b8109
--- /dev/null
+++ b/docs/cpp-coding/01-Preface.md
@@ -0,0 +1,16 @@
+# Preface
+
+C++ Best Practices: A Forkable Coding Standards Document
+
+This document is meant to be a collaborative discussion of the best practices in C++. It complements books such as *Effective C++* (Meyers) and *C++ Coding Standards* (Alexandrescu, Sutter). We fill in some of the lower level details that they don't discuss and provide specific stylistic recommendations while also discussing how to ensure overall code quality.
+
+In all cases brevity and succinctness is preferred. Examples are preferred for making the case for why one option is preferred over another. If necessary, words will be used.
+
+
+<a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/Text" property="dct:title" rel="dct:type">C++ Best Practices</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://cppbestpractices.com" property="cc:attributionName" rel="cc:attributionURL">Jason Turner</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>.
+
+*Disclaimer*
+
+This document is based on my personal experiences. You are not supposed to agree with it 100%. It exists as a book on [GitHub](https://github.com/lefticus/cppbestpractices) so that you can fork it for your own uses or submit back proposed changes for everyone to share.
+
+This book has inspired an O'Reilly video: [Learning C++ Best Practices](http://shop.oreilly.com/product/0636920049814.do)