aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2015-07-12 15:10:05 +0300
committerBozhidar Batsov <bozhidar@batsov.com>2015-07-12 15:10:05 +0300
commit94630a44431d315d325bdb15be02a5bbb37fbd5a (patch)
tree335ce00445e3541da15411352729937bb0610612 /README.md
parentee76b8fabe04ce011b164b8b6e607aca200914e4 (diff)
[Fix #661] Simplify the instructions for overriding compile/test/run commands
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 7 insertions, 30 deletions
diff --git a/README.md b/README.md
index 3d098e8..500b694 100644
--- a/README.md
+++ b/README.md
@@ -525,40 +525,17 @@ the files in you repository, you could do:
((nil . ((projectile-git-command . "/path/to/other/git ls-files -zco --exclude-standard"))))
```
-#### Configure Project's Compilation Command
+#### Configure a Project's Compilation, Test and Run commands
-Overriding pieces of Projectile might require some hacking on your
-part -- reading the source, advising functions, etc.
+There are a few variables that are intended to be customized via `.dir-locals.el`.
-For example, by reading Projectile's source, you could discover that
-a project's compilation command can be specified with this code:
+* for compilation - `projectile-project-compilation-cmd`
+* for testing - `projectile-project-test-cmd`
+* for running - `projectile-project-run-cmd`
-```
-((nil . ((eval . (progn
- ;; require projectile; the following code will fail
- ;; without it.
- (require 'projectile)
- ;; provide a fake "recent" compilation cmd
- ;; which will be returned by the function
- ;; `projectile-compilation-command`
- (puthash (projectile-project-root)
- "./command-to-compile-your-project.sh"
- projectile-compilation-cmd-map))))))
-```
-
-#### Configure Project's Test Command
+They're all set to `nil` by default, but by setting them you'll override the
+default commands per each supported project type.
-Altering the test command works in the same way as altering the
-compilation command. Comments are left out in this example for
-brevity and clarity:
-
-```
-((nil . ((eval . (progn
- (require 'projectile)
- (puthash (projectile-project-root)
- "./test-project.sh"
- projectile-test-cmd-map))))))
-```
### Helm Integration