Note the usage of asciiflow.com for diagrams

Anyone who's spec has diagrams or figures is encouraged to use asciiflow.com
to generate the diagrams and figures.

Change-Id: I999d6eb3a4b0d48f276e273814dd351057b70c87
This commit is contained in:
Kyle Mestery 2014-04-15 01:20:49 +00:00
parent 4f354e9fd2
commit 9799551350
1 changed files with 7 additions and 0 deletions

View File

@ -33,6 +33,13 @@ Some notes about using this template:
* To test out your formatting, build the docs using tox, or see:
http://rst.ninjs.org
* If you would like to provide a diagram with your spec, ascii diagrams are
required. http://asciiflow.com/ is a very nice tool to assist with making
ascii diagrams. The reason for this is that the tool used to review specs is
based purely on plain text. Plain text will allow review to proceed without
having to look at additional files which can not be viewed in gerrit. It will
also allow inline feedback on the diagram itself.
Problem description
===================