commit 78f08016f4dba8d7668b2bb9725df97e7c158ce7
parent 83d903c23bd3ecccf3ec836b5fae05169342dfce
Author: bkopf <vetlehaf@stud.ntnu.no>
Date: Tue, 20 Nov 2018 22:32:24 +0100
Add file with syntax description
Diffstat:
| A | syntax.md | | | 32 | ++++++++++++++++++++++++++++++++ |
1 file changed, 32 insertions(+), 0 deletions(-)
diff --git a/syntax.md b/syntax.md
@@ -0,0 +1,32 @@
+Syntax for 'v1.0'
+=================
+
+Valid symbols
+-------------
+- Joints and corners: `+`
+- Lines: `-`, `|`
+- Arrows `v`, `^`, `<`, `>`
+- All symbols are allowed within a rectangle
+
+Use
+---
+- Rectangles are defined by four corners connected by lines or joints
+- Rectangles can have as many joints as fits, but these should be connected to
+ lines
+- Text is only supported inside rectangles
+- Only text is supported inside rectangles
+ (everything within the rectangle boundaries is read as the rectangle label).
+- Lines *must* start / end with a joint or an arrow
+- Lines can have as many joints as it can fit
+- Arrows *must* point away from the line that they end
+
+v2.0 (proposal)
+===============
+- Text should be allowed wherever in the figure.
+ It should simply be read from the first to the last letter.
+- Rectangles can contain everything that is allowed in the figure itself.
+ (See issue about recursive Figures / rectangles or something )
+
+v3.0 (proposal)
+---------------
+- Diagonal lines `/`, `\`, for instance for
