Skip to content
This repository
Browse code

Adjust README about demo directory. [doc]

  • Loading branch information...
commit f3b1cd8902b37275e3c52650366428643f722b55 1 parent cb89d0d
7rans authored May 27, 2012

Showing 1 changed file with 7 additions and 7 deletions. Show diff stats Hide diff stats

  1. 14  README.rdoc
14  README.rdoc
Source Rendered
@@ -94,15 +94,15 @@ To run a document through QED, simply use the +qed+ command.
94 94
 The <code>-v</code> option specifies verbatim mode, which outputs the entire
95 95
 document.
96 96
 
97  
-Notice we placed the QED document in a <code>demo/</code> directory, there is
98  
-no standard place that demonstrations have to go. They can be placed anywhere
99  
-in a project that is preferred (lately I've been use `qed/`). However, the 
100  
-`qed` command will look for `qed/`, `demo/`, `demos/` and `spec/` in that order
101  
-if no location is specified.
  97
+Notice we placed the QED document in a <code>demo/</code> directory. This is the
  98
+canonical location, but there is no place that demonstrations have to go. They
  99
+can be placed anywhere that is preferred. However, the `qed` command
  100
+will look for `qed/`, `demo/`, `demos/` and `spec/`, in that order, if no
  101
+path is given.
102 102
 
103 103
 Also notice the use of `<code>01_</code>` prefix in front of the file name.
104  
-While this is not strictly necessary, it helps order the documents nicely,
105  
-in particular when generating QED documentation ("QEDocs").
  104
+While this is not strictly necessary, QED sorts the documents, so it helps order
  105
+the documents nicely, in particular when generating QED documentation ("QEDocs").
106 106
 
107 107
 === Utilizing Applique
108 108
 

0 notes on commit f3b1cd8

Please sign in to comment.
Something went wrong with that request. Please try again.