Updated Quick Start and Usage docs

Colin McMillen mcmillen at cs.cmu.edu
Fri May 12 14:56:17 CDT 2006


On Fri, May 12, 2006 at 03:19:58PM -0400, Sébastien Pierre wrote:
> Le vendredi 12 mai 2006 à 14:09 -0500, Matt Mackall a écrit :
> > > Sources and fonts (for modifications):
> > > http://people.type-z.org/seb/mercurial/Mercurial-QuickStart-v1.0.svg
> > > http://people.type-z.org/seb/mercurial/Mercurial-Usage-v1.0.svg
> > 
> > We could stick these in contrib, if you wanted.
> > 
> > > http://people.type-z.org/seb/mercurial/OldSansBlack.ttf
> > > http://people.type-z.org/seb/mercurial/ProggyTiny.ttf
> > 
> > But the fonts might be a problem.
> 
> Yes, or maybe there is a possibility to embed the fonts within the
> SVG... or we could also produce PDF versions of the SVG and then include
> them in contrib (or docs). The PNG format is definitely not the best one
> for distributing documents.

These look wonderful!

But a few minor comments on these versions -- mostly some minor spelling
touchups that will make them look fully polished. These look like a lot
but it shouldn't take much work to fix these :)

For the "QuickStart" doc:

* Under "Working repository", there should be no extra space before the !
in "There can be many !" (This is a consistent problem throughout; maybe
it is supposed to be intentional, but it looks unprofessional to me.)

* Similarly, "do your own cuisine :" should be "do your own cuisine:"
Also, "cuisine" is weird; I'd prefer "work", or else maybe "cooking" (in
American English, "cuisine" usually refers to a style of food, and not
the actual making of the food.)

* In the bit on revision numbers, "commited" -> "committed"

* Under "Misc", "Explicitely" -> "Explicitly"

* In the "basics" section, I'd use ~/projects/myproject, just to be
consistent with the Usage document.

For the "Usage" document:

* "Who changed what, when in a file ?" -> "Who changed what, when in a
  file?" (again, remove space)

* "Is the current branch merged from others ?" (remove space)

* "You cannot undo a rollback !" (remove space)

* "You should have a clean WD" -> "You should have a clean working dir"
  (if there is space to write that)

* "Apply a patch that some sent you" -> "Apply a patch that someone sent
  you"

* There seems to be an extra space in "REV will be the new parent, local
  changes are cleaned" (between "local" and "changes")

- Colin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 191 bytes
Desc: Digital signature
Url : http://www.selenic.com/pipermail/mercurial/attachments/20060512/f038e4d9/attachment.pgp


More information about the Mercurial mailing list