From 944d8e13e1248fd0b916ece50b4854f3cf9f90fb Mon Sep 17 00:00:00 2001 From: Andrew Pardoe Date: Tue, 4 Apr 2017 08:05:24 -0700 Subject: [PATCH] Update with tag info --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 42cc1bd..ee456c4 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,10 @@ they can be freely copied and modified to meet your organization's needs. ## Getting started -The guidelines themselves are found at [CppCoreGuidelines](CppCoreGuidelines.md). There is also [a version formatted for browsing] (http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) that is manually integrated and thus slightly older than the version in the master branch. +The guidelines themselves are found at [CppCoreGuidelines](CppCoreGuidelines.md). The document is in GH-flavored MarkDown. It is intentionally kept simple, mostly in ASCII, to allow automatic post-processing such as language translation and reformatting. The editors maintain one +[version formatted for browsing](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines). Note that it manually integrated and can be slightly older than the version in the master branch. + +The Guidelines are a constantly evolving document without a strict "release" cadence. Bjarne Stroustrop periodically reviews the document and increments the version number in the introduction. [Checkins that increment the version number](https://github.com/isocpp/CppCoreGuidelines/releases) are tagged in git. Many of the guidelines make use of the header-only Guideline Support Library. One implementation is available at [GSL: Guideline Support Library](https://github.com/Microsoft/GSL). -- 2.11.4.GIT