Source

Sublime TFS / readme.md

Diff from to

readme.md

+Sublime TFS
 # [Sublime TFS](https://bitbucket.org/CDuke/sublime-tfs)
+
 Sublime TFS is a plugin for the wonderful text editor [Sublime Text 2](http://sublimetext.com/2) and [Sublime Text 3](http://sublimetext.com/3).
 
 ## Overview
-Base commands are:
 
-* Checkout file
-* Checkin file
-* Get latest version of file
-* View history of file
-* Compare file with version
-* Undo changes in file
-* Check file status
-* Add file
-* Delete file
-* Annotate (Blame)
+Plugin adds **TFS** menu to `Main.sublime-menu`.
+
+Plugin adds the following commands to `Context.sublime-menu`:
+
+- **Checkout**               - Checkout current file
+- **Undo**                   - Undo changes in current file
+- **Checkin...**             - Show checkin current file dialog
+- **History...**             - Show current file history
+- **Add**                    - Add current file to TFS
+- **Get Latest Version**     - Get latest version of current file
+- **Compare With Latest...** - Compare current file with latest version
+- **Delete**                 - Delete current file from TFS (remove file from storage too)
+- **Status**                 - Check current file TFS status
+- **Annotate...**            - Annotate (blame)
+- **Checkout Open Files**    - Checkout all open files
+
+
+Plugin adds the following commands to `Side Bar.sublime-menu`:
+
+- **Get Latest Version**     - Get latest version of selected in SideBar folder
 
 ## Settings
-After installation, the `tf_path` setting must be set. It specifies the path to tf.exe.
-Usually it's in _C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\TF.exe_ for x64 and
-in _C:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE\TF.exe_ for x86.
 
-The Annotate command requires the TFS Power Tools. You must set the `tfpt_path` setting to the path to TFPT.exe.
-Usually it's in _C:\Program Files (x86)\Microsoft Team Foundation Server 2010 Power Tools\TFPT.exe_ for x64 and
-in _C:\Program Files\Microsoft Team Foundation Server 2010 Power Tools\TFPT.exe_ for x86.
+### [tf_path]
+
+It specifies path to Team Foundation **(TF.exe)**. Mandatory for all commands.
+
+Usually it's in:
+
+* **x86** - `C:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE\TF.exe`
+* **x64** - `C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\TF.exe`
+
+### [tfpt_path]
+
+It specifies path to TFS Power Tools **(TFPT.exe)**. Mandatory for **Annotate** command.
+
+Usually it's in:
+
+* **x64** - `C:\Program Files (x86)\Microsoft Team Foundation Server 2010 Power Tools\TFPT.exe`
+* **x86** - `C:\Program Files\Microsoft Team Foundation Server 2010 Power Tools\TFPT.exe`
+
+### [auto_checkout_enabled]
+
+If `auto_checkout_enabled` is set to `false` - Sublime Text will show confirmation prompt on every checkout attempt, otherwise it will attempt checkout file on modification/save silently.
 
 ## Usage
-For almost all commands, except Add, the current file should be under TFS version control.
-After opening a file, you can execute a command in main menu `TFS` or from context menu.
+
+For almost all commands, except **Add**, the current file should be under TFS version control.
+After opening a file, you can execute a command in main menu **TFS** or from context menu.