branch: master
commit 65209dcedc92144e290bde27cbfe49a959737979
Author: Alexey Veretennikov <txm.four...@gmail.com>
Commit: Alexey Veretennikov <txm.four...@gmail.com>
Updated readme and increased the version
---
README.md | 58 +++++++++++++++++++++++++++++++++++++---------------------
ztree.el | 2 +-
2 files changed, 38 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index 30443a2..f6a6ea2 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,36 @@
-ztree
-=====
+# ztree
+Ztree is a project dedicated to implementation of several text-tree
applications inside GNU Emacs. It consists of 2 subprojects: **ztree-diff** and
**ztree-dir**(the basis of **ztree-diff**). Available in **GNU ELPA** and
**MELPA**.
-Ztree is a project dedicated to implementation of several text-tree
applications inside Emacs. It consists of 2 subprojects: **ztree-diff** and
**ztree-dir**(the basis of **ztree-diff**). Available in **GNU ELPA** and
**MELPA**.
+## Installation
-ztree-diff
-==========
-**ztree-diff** is a directory-diff tool for Emacs inspired by commercial tools
like Beyond Compare or Araxis Merge. It supports showing the difference between
two directories; calling **Ediff** for not matching files, copying between
directories, deleting file/directories, hiding/showing equal files/directories.
+### Using ELPA
+Press `M-x` in GNU Emacs and write `list-packages`. Find the `ztree` in the
list of packages and press `i` to select this package, `x` to install the
package.
-The comparison itself performed with the external **GNU diff** tool, so make
sure to have one in the executable path. Verified on OSX and Linux.
+### Using MELPA
+Add to your `.emacs` or `.emacs.d/init.el` following lines:
-If one wants to have a stand-alone application, consider the
(WIP)[zdircmp](https://github.com/fourier/zdircmp) project based on
**ztree-diff**.
+```scheme
+(setq package-archives '(("gnu" . "http://elpa.gnu.org/packages/";)
+ ("melpa" . "http://melpa.milkbox.net/packages/";)))
+```
+
+Follow the installation instructions for the GNU ELPA above.
+### Manual
Add the following to your .emacs file:
```scheme
(push (substitute-in-file-name "path-to-ztree-directory") load-path)
-(require 'ztree-diff)
+(require 'ztree)
```
+## ztree-diff
+**ztree-diff** is a directory-diff tool for Emacs inspired by commercial tools
like Beyond Compare or Araxis Merge. It supports showing the difference between
two directories; calling **Ediff** for not matching files, copying between
directories, deleting file/directories, hiding/showing equal files/directories.
+
+The comparison itself performed with the external **GNU diff** tool, so make
sure to have one in the executable path. Verified on OSX and Linux.
+
+If one wants to have a stand-alone application, consider the
(WIP)[zdircmp](https://github.com/fourier/zdircmp) project based on
**ztree-diff**.
+
Call the `ztree-diff` interactive function:
```
@@ -25,45 +38,48 @@ M-x ztree-diff
```
Then you need to specify the left and right directories to compare.
-###Hotkeys supported
-The basic hotkeys are the same as in the **ztree-dir**. Additionally:
+### Hotkeys supported
+ * Open/close directories with double-click, `RET` or `Space` keys.
+ * To jump to the parent directory, hit the `Backspace` key.
+ * To toggle open/closed state of the subtree of the current directory, hit
the `x` key.
* `RET` on different files starts the **Ediff** (or open file if one absent
or the same)
* `Space` show the simple diff window for the current file instead of
**Ediff** (or view file if one absent or the same)
* `TAB` to fast switch between panels
* `h` key to toggle show/hide identical files/directories
+ * `H` key to toggle show/hide hidden/ignored files/directories
* `C` key to copy current file or directory to the left or right panel
* `D` key to delete current file or directory
* `v` key to quick view the current file
* `r` initiates the rescan/refresh of current file or subdirectory
* `F5` forces the full rescan.
-Screenshots:
+### Customizations
+By default all files starting with dot (like `.gitignore`) are not shown and
excluded from the difference status for directories. One can add an additional
regexps to the list `ztree-diff-filter-list`.
+
+### Screenshots
+## ztree-dir
-ztree-dir
----------
**ztree-dir** is a simple text-mode directory tree for Emacs. See screenshots
below for the GUI and the terminal versions of the **ztree-dir**.
-As above Add the following to your .emacs file:
-
-```scheme
-(push (substitute-in-file-name "path-to-ztree-directory") load-path)
-(require 'ztree-dir)
-```
-
Call the `ztree-dir` interactive function:
```
M-x ztree-dir
```
+### Hotkeys supported
* Open/close directories with double-click, `RET` or `Space` keys.
* To jump to the parent directory, hit the `Backspace` key.
* To toggle open/closed state of the subtree of the current directory, hit the
`x` key.
+* To visit a file, press `Space` key.
+* To open file in other window, use `RET` key.
+
+Set the `ztree-dir-move-focus` variable to `t` in order to move focus to the
other window when the `RET` key is pressed; the default behavior is to keep
focus in `ztree-dir` window.
diff --git a/ztree.el b/ztree.el
index 2f739aa..01d7c06 100644
--- a/ztree.el
+++ b/ztree.el
@@ -6,7 +6,7 @@
;;
;; Created: 2013-11-1l
;;
-;; Version: 1.0.1
+;; Version: 1.0.2
;;
;; Keywords: files tools
;; URL: https://github.com/fourier/ztree
