From 31ec39db7f6105323c28949a31289373cd4abaeb Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Fri, 20 Feb 2015 10:43:54 +0000 Subject: [PATCH] Actually add the README --- README.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..69952933 --- /dev/null +++ b/README.rst @@ -0,0 +1,24 @@ +This repository contains the documentation for Matrix. + +Structure +========= + +- ``api`` : Contains the HTTP API specification. +- ``drafts`` : Contains documents which will make it into the specification + and/or supporting documentation at some point in the future. +- ``meta`` : Contains documents outlining the processes involved when writing + documents, e.g. documentation style, guidelines. +- ``scripts`` : Contains scripts to generate formatted versions of the + documentation, typically HTML. +- ``specification`` : Contains the specification split up into sections. +- ``supporting-docs`` : Contains additional documents which explain design + decisions, examples, use cases, etc. + +Contributing +============ + +Known issues with the specification are represented as JIRA issues at +https://matrix.org/jira/browse/SPEC + +If you want to ask more about the specification, or have suggestions for +improvements, join us on ``#matrix-dev:matrix.org``.