From 3933660c9d1c2074ac303bd5db472f315676b3dc Mon Sep 17 00:00:00 2001 From: Jeetaditya Chatterjee Date: Thu, 13 May 2021 21:49:24 +0100 Subject: [PATCH] Revert "fix: punctuation and wording." This reverts commit b0155b02b0dd83519e192ba6951dc5eecee8130a. --- modules/ui/treemacs/README.org | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/modules/ui/treemacs/README.org b/modules/ui/treemacs/README.org index 531489223..87eeb328d 100644 --- a/modules/ui/treemacs/README.org +++ b/modules/ui/treemacs/README.org @@ -14,8 +14,12 @@ - [[#troubleshooting][Troubleshooting]] * Description -[[https://github.com/Alexander-Miller/treemacs][Treemacs]] is a file and project explorer similar to NeoTree or vim’s NerdTree, but largely inspired by the Project Explorer in Eclipse. It shows the file system outlines of your projects in a simple tree layout allowing quick navigation and exploration, while also possessing basic file management utilities. -It includes: +This module adds the treemacs project sidebar + +#+begin_quote +It is a little more powerful +a little cooler than neotree +#+end_quote + Integration with Git (when =:tools magit= is enabled) + Integration with Evil (when =:editor evil +everywhere= is enabled) @@ -41,10 +45,10 @@ It includes: * Prerequisites If ~+treemacs-git-mode~ is set to ~extended~ or ~deferred~ you will need to have -~python3~ installed. +~python3~ installed * Features -The project bar can be opened using =SPC o p=. +The project bar can be opened using =SPC o p= | Keybind | Description | |---------+-----------------------------------------------------------------| @@ -52,8 +56,7 @@ The project bar can be opened using =SPC o p=. | =o v= | Open a vertical dired buffer on the currently highlighted node | * Configuration -The variable ~+treemacs-git-mode~ sets the type of git integration that treemacs -has. +the variable ~+treemacs-git-mode~ sets the type of git integration for treemacs There are 3 possible values: