aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorFranck Cuny <franckcuny@gmail.com>2016-11-11 14:16:08 -0800
committerFranck Cuny <franckcuny@gmail.com>2016-11-11 14:16:08 -0800
commit6cd87fb85cbf78c0d8d19121fd99bea3c75b63d1 (patch)
tree223bbbe3b9111dccb9db0d4b075ce35a2d7d329c /README.org
parentRemove doc header for ivy. (diff)
downloadpants.el-6cd87fb85cbf78c0d8d19121fd99bea3c75b63d1.tar.gz
Update README with a couple of missing settings.
Diffstat (limited to 'README.org')
-rw-r--r--README.org6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.org b/README.org
index c4d1997..4556500 100644
--- a/README.org
+++ b/README.org
@@ -10,7 +10,7 @@ Get a copy of the repository:
git clone git@github.com:franckcuny/pants.el.git
#+END_SRC
-Then update your emacs' configuration:
+Then update your Emacs configuration:
#+BEGIN_EXAMPLE
(load-file "~/src/pants.el/pants.el")
@@ -30,6 +30,8 @@ Then update your emacs' configuration:
There's a few variables that you can set:
+- *pants-completion-system*: Which completion system to use. The possible values are Ivy, Ido and Helm. Ivy is the default one.
+
- *pants-source-tree-root*: Path to the repository.
- *pants-ini*: Name of the pants.ini file to use (default is =pants.ini=).
@@ -42,6 +44,8 @@ There's a few variables that you can set:
- *pants-extra-args*: Optional arguments to use with every call to =pants= (for example: "-q")
+- *pants-exec-args*: Optional arguments to the pants executable. The default is =--no-color=
+
** Usage
*** Go to the closest BUILD file