Merge pull request #11 from openshmem-org/readme-md

Create initial readme.md
openshmem-org · Aug 18, 2016 · 018862f · 018862f
2 parents d276018 + 9bc916a
commit 018862f
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# OpenSHMEM Application Programming Interface
+
+This repository contains the LaTeX source for the OpenSHMEM specification.
+
+## Organization of the Repository
+
+The current version of the OpenSHMEM specification is maintained in the ```master``` branch.  Each published version of the specification is marked with a tag of the format ```vX.Y``` where X and Y are the major and minor version numbers.  The in-progress development work of the next version of the OpenSHMEM specification is maintained in the ```osh_spec_next``` branch.
+
+## Proposing Changes to the Specification
+
+Changes should be proposed as pull requests against the ```osh_spec_next``` branch.  Text changes must be ratified through the OpenSHMEM specification committee and the pull request must also reference the Redmine ticket being used to track the proposal.  All changes must pass CI testing and require two reviews before merging.