/doc/source/preface.txt

https://bitbucket.org/tortoisehg/hgtk/ · Plain Text · 114 lines · 79 code · 35 blank · 0 comment · 0 complexity · aed9ae57cae802f2df42b80808b34609 MD5 · raw file

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