diff options
| author | Franck Cuny <franckcuny@gmail.com> | 2016-08-04 09:19:38 -0700 |
|---|---|---|
| committer | Franck Cuny <franckcuny@gmail.com> | 2016-08-04 09:19:38 -0700 |
| commit | bb2bbdae35117401640d17bbda1e8c4b949aa95b (patch) | |
| tree | f97c408404b622f28f45c3c393f78aa73e5c3a37 /README.md | |
| parent | Rename 'helm' buffer and change the prompt. (diff) | |
| download | pants.el-bb2bbdae35117401640d17bbda1e8c4b949aa95b.tar.gz | |
Converted README from markdown to org-mode.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 818a99f..0000000 --- a/README.md +++ /dev/null @@ -1,61 +0,0 @@ -# pants.el - -## Description - -## Install - -Get a copy of the repository: - -```sh -git clone git@github.com:franckcuny/pants.el.git -``` - -Then update your emacs' configuration: - -```elisp -(load-file "~/src/pants.el/pants.el") - -(use-package pants - :bind (("C-c b" . pants-find-build-file) - ("C-c r" . pants-run-binary) - ("C-c t" . pants-run-test)) - :config - (progn - (setq pants-source-tree-root "/Users/fcuny/src/source" - pants-bury-compilation-buffer t - pants-extra-args "-q"))) -``` - -## Configuration - -There's a few variables that you can set: - -* **pants-source-tree-root**: Path to the repository. - -* **pants-ini**: Name of the pants.ini file to use (default is `pants.ini`). - -* **pants-exec-name**: Path to the pants executable in the repository (default is `pants`) - -* **pants-build-file**: Name of the BUILD file to look for - -* **pants-bury-compilation-buffer**: Set to true if you want to bury the compilation buffer after running successfully a command - -* **pants-extra-args**: Optional arguments to use with every call to `pants` (for example: "-q") - -## Usage - -### Go to the closest BUILD file - -Do `m-x pants-find-build-file`. - -### Run a binary target - -Do `m-x pants-run-binary`. It will present a list of targets and let you select which one to run. - -### Run a test target - -Do `m-x pants-run-test`. It will present a list of targets and let you select which one to run. - -### Jump to a REPL - -Do `m-x pants-run-python-repl`. It will present a list of targets and create a REPL. |