Permalink
Browse files

added README

  • Loading branch information...
1 parent 02cee2f commit af2dbcd3f9dda10dcad3b1181723b7b6cf004092 @gornostal committed Jun 1, 2012
Showing with 67 additions and 1 deletion.
  1. +1 −0 .gitignore
  2. +66 −1 README.md
View
1 .gitignore
@@ -1,2 +1,3 @@
*.pyc
+images
!.gitignore
View
67 README.md
@@ -1,2 +1,67 @@
Modific
-=======
+=========
+
+Modific is a ST2 plugin for highlighting lines changed from the last commit (you know what I mean if you used Netbeans).
+
+For now it supports **Git**, **SVN** and **Mercurial**.
+
+
+Install
+-------
+
+The easiest way to install is through **[Package Control](http://wbond.net/sublime\_packages/package\_control)**.
+
+Once you install Package Control, restart ST2 and bring up the Command Palette (`Ctrl+Shift+P` on Linux/Windows, `Cmd+Shift+P` on OS X). Select "Package Control: Install Package", wait while Package Control fetches the latest package list, then select *Modific* when the list appears. The advantage of using this method is that Package Control will automatically keep *Modific* up to date with the latest version.
+
+Or you can **download** the latest source from [GitHub](https://github.com/gornostal/Modific/zipball/master) and copy the *Modific* folder to your Sublime Text "Packages" directory.
+
+Or **clone** the repository to your Sublime Text "Packages" directory:
+
+ git clone git://github.com/gornostal/Modific.git
+
+
+The "Packages" directory is located at:
+
+* OS X:
+
+ ~/Library/Application Support/Sublime Text 2/Packages/
+
+* Linux:
+
+ ~/.config/sublime-text-2/Packages/
+
+* Windows:
+
+ %APPDATA%/Sublime Text 2/Packages/
+
+Please, make sure your VCS binaries is in the PATH (**especially if you are on Windows**).
+To do that on Windows, open `Controll Panel -> System -> Advanced system settings -> Environment variables -> System Variables`, find PATH, click "Edit" and append `;C:\path\to\VCS\binaries` for every VCS you will use (or make sure it's already there).
+
+Features / Usage
+----------------
+
+**Highlight changes** *(automatically: on save or when window gets focus)*
+[![Highlight changes](http://i.imgur.com/FgpyRl.jpg)](http://i.imgur.com/FgpyR.jpg)
+
+**Show diff** `Ctrl+Alt+D` on Linux/Windows, `Ctlr+Super+D` on OS X
+[![Show diff](http://i.imgur.com/csCw7l.jpg)](http://i.imgur.com/csCw7.jpg)
+
+**Preview of the commited code for current line** `Ctrl+Alt+C` on Linux/Windows, `Ctlr+Super+C` on OS X
+[![Preview](http://i.imgur.com/siVOXl.jpg)](http://i.imgur.com/siVOX.jpg)
+
+**Revert modification** `Ctrl+Alt+R` on Linux/Windows, `Ctlr+Super+R` on OS X
+This command reverts modifications if your cursor stays on modified line (or if on group of lines, then whole group will be reverted)
+
+For those who expected to see a clone of Netbeans feature - unfortunately, with existing ST2 API that is impossible :(
+
+Configuring
+-----------
+
+Open `Prefrences -> Package Settings -> Modific -> Settings - Default` and look for available settings.
+If you want to change something, don't do it in this file. Open `Prefrences -> Package Settings -> Modific -> Settings - User` and put there your configuration.
+
+Basically, all you can configure is a type of icon (dot, circle or bookmark) and path for your CVS binaries.
+
+License
+-------
+Released under the [WTFPLv2](http://sam.zoy.org/wtfpl/COPYING).

0 comments on commit af2dbcd

Please sign in to comment.