From f9806de39748b51558f96b39f7d37b4c73df78a3 Mon Sep 17 00:00:00 2001
From: Jeetaditya Chatterjee <jeetelongname@gmail.com>
Date: Thu, 13 May 2021 21:39:31 +0100
Subject: [PATCH] doc:finish Sections of the README (now with +lsp!)

---
 modules/ui/treemacs/README.org | 37 ++++++++++++++++++++++++----------
 1 file changed, 26 insertions(+), 11 deletions(-)

diff --git a/modules/ui/treemacs/README.org b/modules/ui/treemacs/README.org
index 6f4ec8062..58701c87d 100644
--- a/modules/ui/treemacs/README.org
+++ b/modules/ui/treemacs/README.org
@@ -15,6 +15,11 @@
 
 * 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:
+
++ Integration with Git  (when =:tools magit= is enabled)
++ Integration with Evil (when =:editor evil +everywhere= is enabled)
++ Workspace awareness (when =:ui workspaces= is enabled)
 
 ** Maintainers
 + This module has no dedicated maintainers.
@@ -23,33 +28,43 @@
 + =+lsp= Enable ~lsp-treemacs~ integration and add shortcuts for common commands.
 
 ** Plugins
-+ [[https://github.com/Alexander-Miller/treemacs][treemacs]]
-+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-evil.el][treemacs-evil]]
-+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-projectile.el][treemacs-projectile]]
-+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-magit.el][treemacs-magit]]
-+ [[https://github.com/Alexander-Miller/treemacs/blob/master/src/extra/treemacs-persp.el][treemacs-persp]]
-+ [[https://github.com/emacs-lsp/lsp-treemacs][lsp-treemacs]]
++ [[https://github.com/Alexander-Miller/treemacs/][treemacs]]
++ [[https://github.com/Alexander-Miller/treemacs/#treemacs-projectile][treemacs-projectile]]
++ =:editor evil +everywhere=
+  + [[https://github.com/Alexander-Miller/treemacs/#treemacs-evil][treemacs-evil]]
++ =:tools magit=
+  + [[https://github.com/Alexander-Miller/treemacs/#treemacs-magit][treemacs-magit]]
++ =:ui workspaces=
+  + [[https://github.com/Alexander-Miller/treemacs/#treemacs-persptreemacs-perspective][treemacs-persp]]
++ =+lsp=
+  + [[https://github.com/emacs-lsp/lsp-treemacs][lsp-treemacs]]
 
 * Prerequisites
 If ~+treemacs-git-mode~ is set to ~extended~ or ~deferred~ you will need to have
-python3 installed
+~python3~ installed
 
 * Features
-# An in-depth list of features, how to use them, and their dependencies.
+The project bar can be opened using =SPC o p=
+
+| Keybind | Description                                                     |
+|---------+-----------------------------------------------------------------|
+| =o s=     | Open a horizontal dired buffer on the currently highlighted node |
+| =o v=     | Open a vertical dired buffer on the currently highlighted node  |
 
 * Configuration
 the variable ~+treemacs-git-mode~ sets the type of git integration for treemacs
 
 There are 3 possible values:
 
-  1) simple, which highlights only files based on their git status, and is
+  1. simple, which highlights only files based on their git status, and is
      slightly faster,
-  2) extended, which highlights both files and directories, but requires
+  2. extended, which highlights both files and directories, but requires
      python,
-  3) deferred, same as extended, but highlights asynchronously.
+  3. deferred, same as extended, but highlights asynchronously.
 
 the default being simple
 
 This must be set before treemacs has loaded.
+
 * TODO Troubleshooting
 # Common issues and their solution, or places to look for help.