Johan Samyn avatar Johan Samyn committed 9700a47

doc: tidy up ReadMe.txt

actualize examples, use quotes for commandline things,
capitalize productnames

Comments (0)

Files changed (1)

 TortoiseHg Documentation
 
-To build this documentation you need sphinx installed.  On Ubuntu this
-is the python-sphinx package.   On Windows your best bet is
-easy_install.  To build without warnings, you need sphinx 0.6 or later.
+To build this documentation you need Sphinx installed.  On Ubuntu this
+is the python-sphinx package.   On Windows your best bet is easy_install
+or pip.  To build without warnings, you need Sphinx 0.6 or later.
 
 To build PDF files you need LaTeX packages.  On Ubuntu these are
 texlive-latex-extra, texlive-fonts-recommended and all of their
 dependencies.  On Windows the best choice is MiKTeX.
 
 Once all of the prerequisites are in place, you can use the makefile to
-build targets: html htmlhelp latex
+build targets: 'make tml htmlhelp latex'.
 
-Once LaTeX is built, you have to cd into that output directory and run
-make all-pdf to build the actual PDF file.
+Once 'latex' is built, you have to cd into that output directory and run
+'make all-pdf' to build the actual PDF file.
 
-Once htmlhelp is built, you have to run the actual help compiler on a
+Once 'htmlhelp' is built, you have to run the actual HTML Help Compiler on a
 Windows machine.
 
-On Windows, if you have no make tool you can use build.bat. If HTML
-compiler and miktex are installed you can directly generate chm
-(build chm) and pdf (build pdf).
+On Windows, if you have no make tool you can use build.bat. If the HTML Help 
+Compiler and MiKTeX are installed you can directly generate the CHM file 
+('build chm') and PDF file ('build pdf').
 
 Hacking the source
 ==================
 
 - To indicate a menu choice use :menuselection: and -->, for example:
 
-  :menuselection:`TortoiseHg... --> About`
+  :menuselection:`File --> Settings...`
 
 - To indicate a file use :file:, for example:
 
 
 - To indicate a command to enter into command window use :command:, for example:
 
-  :command:`hgtk log`
+  :command:`thg log`
 
 - To indicate a text to enter into a text input field in the GUI use ``, for example:
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.