From bf87d5818fd4b5e5625d02f9a8037d8bda582a00 Mon Sep 17 00:00:00 2001 From: Jeetaditya Chatterjee Date: Thu, 13 May 2021 21:35:09 +0100 Subject: [PATCH] fix: rebase readme too combine lsp settings --- modules/ui/treemacs/README.org | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/modules/ui/treemacs/README.org b/modules/ui/treemacs/README.org index 26ab5c291..6f4ec8062 100644 --- a/modules/ui/treemacs/README.org +++ b/modules/ui/treemacs/README.org @@ -31,13 +31,25 @@ + [[https://github.com/emacs-lsp/lsp-treemacs][lsp-treemacs]] * Prerequisites -This module has no prerequisites. +If ~+treemacs-git-mode~ is set to ~extended~ or ~deferred~ you will need to have +python3 installed * Features -# TODO +# An in-depth list of features, how to use them, and their dependencies. * Configuration -# TODO +the variable ~+treemacs-git-mode~ sets the type of git integration for treemacs -* Troubleshooting -# TODO +There are 3 possible values: + + 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 + python, + 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.