/doc/source/preface.txt

  1*******
  2Preface
  3*******
  4
  5.. module:: preface
  6	:synopsis: About this manual
  7
  8Audience
  9========
 10
 11This book is written for computer literate folk who want to use
 12Mercurial to manage their data, but are uncomfortable using the command
 13line client to do so. Since TortoiseHg is a Windows shell extension it's
 14assumed that the user is familiar with the Windows explorer and knows
 15how to use it.
 16
 17You can find the most up to date version of this documentation at our
 18`web <http://tortoisehg.org>`_ site.
 19
 20Reading guide
 21=============
 22
 23This Preface explains a little about the TortoiseHg project, the
 24community of people who work on it, and the licensing conditions for
 25using it and distributing it.
 26
 27The :doc:`intro` explains what TortoiseHg is, what it does, where it
 28comes from and the basics for installing it on your PC.
 29
 30:doc:`quick` is a quick tutorial on how to start with TortoiseHg.
 31
 32:doc:`daily` is the main chapter, it describes the frequently used
 33components of TortoiseHg.
 34
 35:doc:`settings` describes how to configure TortoiseHg.
 36
 37:doc:`nonhg` describes how to use TortoiseHg as a client for
 38non-Mercurial servers.
 39
 40:doc:`faq` has a list of common questions and their answers.
 41
 42:doc:`debugging` describes how to debug any problems that you find.
 43
 44TortoiseHg is free!
 45===================
 46
 47TortoiseHg is released under 
 48`GPLv2 <http://www.gnu.org/licenses/gpl-2.0.html>`_.  You are free to
 49install it on as many computers as you like, and to redistribute it
 50according to the GPLv2 license.
 51
 52Community
 53=========
 54
 55Mailing Lists:
 56
 57* `Users <https://lists.sourceforge.net/lists/listinfo/tortoisehg-discuss>`_ - Announcements, user Q&A, and feature discussions.
 58* `Developers <thg-dev@googlegroups.com>`_ - Patches, bug reports, development discussions.
 59* `Issues <https://lists.sourceforge.net/lists/listinfo/tortoisehg-issues>`_ - Notifications from the issue tracker.
 60
 61And our `wiki <http://bitbucket.org/tortoisehg/thg/wiki/Home>`_ on Bitbucket.
 62
 63Acknowledgements
 64================
 65
 66Thanks to the many people who contribute to the TortoiseHg project.  It
 67takes a community of developers, translators, and users to build a
 68truly useful tool (especially users who care enough to report bugs and
 69file feature requests).
 70
 71The TortoiseHg installer for Windows includes the TortoiseOverlays handler,
 72as provided by the `TortoiseSVN <http://tortoisesvn.net>`_ project.
 73
 74The history viewer of TortoiseHg is based on hgview
 75`hgview <http://www.logilab.org/project/hgview>`_, a tool developped by
 76`David Douard <david.douard@logilab.fr>`_ and others, with the financial
 77support of `Logilab <http://www.logilab.fr>`_.
 78
 79
 80Conventions used in this manual
 81===============================
 82
 83The following typographical conventions are used in this manual:
 84
 85:kbd:`Ctrl-A`
 86	Indicates a key, or combination of keys, to press.
 87
 88:guilabel:`Commit`
 89	Indicates a label, button or anything that appears in user interfaces.
 90
 91:menuselection:`TortoiseHg... --> About`
 92	Indicates a menu choice, or a combination of menu choice, tab
 93	selection and GUI label.  For example
 94	:menuselection:`TortoiseHg...  --> Global settings --> Commit --> User name`
 95	means do something in :guilabel:`User name` label under
 96	:guilabel:`Commit` tab selectable from the menu choice
 97	:menuselection:`TortoiseHg... --> Global settings`.
 98
 99:file:`.hg/hgrc`
100	Indicates a filename or directory name.
101
102:command:`hgtk log`
103	Indicates a command to enter into command window.
104
105``myproxy:8000``
106	Indicates a text to enter into a text input field in the GUI.
107	
108.. note::
109	This is a note.
110
111.. warning::
112	An important note. Pay attention.
113
114.. vim: noet ts=4