README.rdoc in dnote-1.1.3 vs README.rdoc in dnote-1.1.4
- old
+ new
@@ -5,23 +5,23 @@
* source: http://github.com/proutils/dnote
== DESCRIPTION
-Extract developement notes from source code and generate some nice
+Extract development notes from source code and generate some nice
output formats for them.
== SYNOPSIS
=== Note Structure
-D'Note scans for the common noting pattern used by develepors of many laguages of an all-caps label
-followed bt a colon. To be more specific, for D'Note to recogznie a note, it needs ot follow this
-simple set of rules:
+D'Note scans for the common note patterns used by developers of many languages in the form of an
+all-caps labels followed by a colon. To be more specific, for D'Note to recognize a note,
+it needs to follow this simple set of rules:
-1) Notes start with an all-caps label puctuated with a colon, followed by the note's text.
+1) Notes start with an all-caps label punctuated with a colon, followed by the note's text.
# LABEL: description ...
2) Specially designated notes can omit the colon. By default these are +TODO+,
+FIXME+ and +OPTIMIZE+.
@@ -33,25 +33,25 @@
the note for a <tt><pre></tt> block if it is indented.
# LABEL: description ...
# continue ...
-4) An alternative to the limitation of the last rule is to indent the whole note, making it
-a <tt><pre></tt> block. Then the text layout is free-form.
+4) An alternative to the previous limitation is to indent the whole note, making it
+a <tt><pre></tt> block when rendered by RDoc. Then the text layout is free-form.
# This is a description of something...
#
# LABEL: description ...
# continue ...
-That's all there is to it, if I can convince the developers of RDoc to add recognize labels,
-we may eventually be able to relax the flush rule, which would be very nice.
+That's all there is to it, if I can convince the developers of RDoc to recognize labels,
+we may eventually be able to relax the flush rule too, which would be very nice.
=== Generating Notes
-As you can see the commandline interface is quite straight-forward.
+As you can see the commandline interface is pretty straight-forward.
Usage: dnote [OPTIONS] path1 [path2 ...]
OUTPUT FORMAT: (choose one)
--rdoc RDoc comment format
@@ -68,20 +68,20 @@
STANDARD OPTIONS:
-v, --verbose extra verbose output
--debug debug mode
-h, --help show this help information
-The default path is <tt>**/*.rb</tt> and the default format <tt>--rdoc</tt>.
+The default path is <tt>**/*.rb</tt> and the default format is <tt>--rdoc</tt>.
Here is an example of DNote's current notes in RDoc format:
= Development Notes
== TODO
=== file://lib/dnote/notes.rb
- * TODO: Add ability to read header notes. They oftern
+ * TODO: Add ability to read header notes. They often
have a outline format, rather then the single line. (19)
* TODO: Need good CSS file. (22)
* TODO: Need XSL? (24)
=== file://plug/syckle/services/dnote.rb
@@ -89,14 +89,13 @@
* TODO: Should this service be part of the +site+ cycle? (18)
(4 TODOs)
-
== INSTALLATION
-The usual RubyGem's command:
+The usual RubyGem's command will do the trick.
$ sudo gem install dnote
== COPYRIGHTS
@@ -104,7 +103,6 @@
(MIT License)
Copyright (c) 2006, 2009 Thomas Sawyer
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-