Mercurial > mozilla > hg > DocumentIt

annotate README.txt @ 22:67e4becc7d49

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
first steps for cleaning up this awful mess
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 03 Aug 2011 10:58:45 -0700
parents 10c5e6d11ef8
children 0ce6b501f62d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
62bd66061329 add a helpful help message
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
1 # DocumentIt
0
665b2ae2ecc6 stub project for DocumentIt
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2
665b2ae2ecc6 stub project for DocumentIt
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 Mirror documentation to https://developer.mozilla.org/en/Mozmill
21
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
4
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
5
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
6 ## TODO
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
7
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
8 There are several features that would be nice to have:
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
9
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
10 - inclusion of other files
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
11
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
12 - inclusion of `--help` documentation
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
13
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
14 In general the approach taken shouldn't compromise the general
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
15 approach that the documentation should be the documentation, not
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
16 pre-documentation. This may be achieved by the use of (e.g. regex)
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
17 macros. For instance:
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
18
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
19 append(--help.*$,shell(mozmill --help))
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
20
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
21
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
22
10c5e6d11ef8 add notes on future directions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
23