Commits

guillermooo committed 8455baa

improve readme

Comments (0)

Files changed (1)

 Requirements
 ============
 
-* Mercurial 1.9 or above (command server)
+* Mercurial command server (Mercurial 1.9 or above)
 
 
 Getting Started
 ===============
 
-- `Download`_ and install SublimeHg. (See `installation instructions`_ for ``.sublime-package`` files.)
+- `Download`_ and install SublimeHg. (See the `installation instructions`_ for *.sublime-package* files.)
 
 .. _Download: https://bitbucket.org/guillermooo/sublimehg/downloads/SublimeHg.sublime-package
-.. _installation instructions: http://sublimetext.info/docs/en/extensibility/packages.html#installation-of-packages
+.. _installation instructions: http://docs.sublimetext.info/en/latest/extensibility/packages.html#installation-of-sublime-package-files
 
 
 Configuration
 =============
 
-Available options in **Preferences | Settings - User**.
+These options can be set in **Preferences | Settings - User**.
 
 ``packages.sublime_hg.hg_exe``
 
 	By default, the executable name for Mercurial is ``hg``. If you need to
 	use a different one, such as ``hg.bat``, change this option.
-	``packages.sublime_hg.hg_exe`` to it in **Preferences | Global Settings -
-	User**.
 
 	Example::
 
 
 ``packages.sublime_hg.terminal``
 
-	Determines the terminal emulator to be used in Linux. This is necessary so
-	that commands such as *serve* work.
+	Determines the terminal emulator to be used in Linux. Some commands, such
+	as *serve*, need this information to work.
 
 ``packages.sublime_hg.extensions``
 
 	A list of Mercurial extension names. Commands belonging to these extensions
-	will show up in the command menu along with built-in Mercurial commands.
+	will show up in the SublimeHg quick panel along with built-in Mercurial
+	commands.
 
 
 How to Use
 
 SublimeHg can be used in two ways:
 
-- Through a *menu*: ``show_sublime_hg_menu`` command.
-- Through a *command-line* interface: ``show_sublime_hg_cli`` command.
+- Through a *menu* (``show_sublime_hg_menu`` command).
+- Through a *command-line* interface (``show_sublime_hg_cli`` command).
 
-Regardless of the method used to call it, SublimeHg ultimately talks to the
-Mercurial command server. The command-line interface is the more flexible
-option, but some operations might be quicker through the menu.
+Regardless of the method used, SublimeHg ultimately talks to the Mercurial
+command server. The command-line interface is the more flexible option, but
+some operations might be quicker through the menu.
 
-Normally, you will follow these steps to use SublimeHg:
+By default, you have to follow these steps to use SublimeHg:
 
 #. Open the Command Palette (``Ctrl+Shift+P``) and look for ``SublimeHg``.
 #. Select option
 #. Select Mercurial command (or type in command line)
 
-Alternatively, you can assign ``show_sublime_hg_cli`` and ``show_sublime_hg_menu``
-their own key bindings.
+It is however **recommended to assign** ``show_sublime_hg_cli`` and
+``show_sublime_hg_menu`` their own **key bindings**.
 
-Restarting The Current Server
+For example::
+
+	{ "keys": ["ctrl+k", "ctrl+k"], "command": "show_sublime_hg_menu" },
+	{ "keys": ["ctrl+shift+k"], "command": "show_sublime_hg_cli" },
+
+
+Restarting the Current Server
 -----------------------------
 
-Sometimes you will need restart the current server so that external changes
-to the repository are picked up. To do that, choose Kill Current Server from
-the command palette.
-
-.. # History
-.. -------
-
-.. Open the SublimeHg command line and type:
-
-.. ``!h``
-..    Displays history.
-
-.. ``!mkh``
-..    Persists current history between sessions.
+The Mercurial command server will not detect changes to the repository made
+from the outside (perhaps from a command line) while it is running. To restart
+the current server so that external changes are picked up, select
+*Kill Current Server* from the command palette.
 
 Tab Completion
 --------------