Skip to content

Commit 0b7373d

Browse files
authored
Improve readme, add bbin instructions, neil.el docs, fix typos (#248)
1 parent 935190c commit 0b7373d

File tree

2 files changed

+45
-7
lines changed

2 files changed

+45
-7
lines changed

README.md

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,16 @@ $ nix-shell -p neil
3030
# Alternatively, if your nix channel doesn't have neil yet:
3131
$ nix-shell -I nixpkgs=channel:nixos-unstable -p neil
3232
```
33+
### [BBin](https://github.com/babashka/bbin/)
34+
35+
```bash
36+
$ bbin install io.github.babashka/neil
37+
```
3338

3439
### Clojure
3540

41+
If possible, use the above methods instead, as this would have a much slower startup. Another problem is that the global `:neil` alias can be overridden by a local one, making it [impossible to use inside the neil repo itself](https://github.com/babashka/neil/issues/246).
42+
3643
Add the following alias to your global or project-local `deps.edn`:
3744

3845
``` clojure
@@ -201,8 +208,8 @@ will return libraries with 'test framework' in their description.
201208

202209
### license list
203210

204-
List/search for licenses that can be added to a project with `neil`. This functionality uses Github's license API,
205-
which is also used by [choosealicense.com](https://choosealicense.com/). With no search term, a list of
211+
List/search for licenses that can be added to a project with `neil`. This functionality uses Github's license API,
212+
which is also used by [choosealicense.com](https://choosealicense.com/). With no search term, a list of
206213
commonly-used licenses is returned:
207214

208215
```
@@ -241,9 +248,11 @@ $ neil license add epl-1.0
241248
Will create a LICENSE file in the current directory with the EPL 1.0 text.
242249

243250
## Emacs Integration
251+
[![MELPA status](https://melpa.org/packages/neil-badge.svg)](https://melpa.org/#/neil)
244252

245253
[neil.el](https://github.com/babashka/neil/blob/main/neil.el) is a companion Emacs package.
246254

255+
### Installation
247256
Load it using your preferred Emacs package manager, e.g., for Doom Emacs:
248257

249258
```emacs-lisp
@@ -254,16 +263,45 @@ Load it using your preferred Emacs package manager, e.g., for Doom Emacs:
254263
;; config.el
255264
256265
(use-package! neil
257-
:config
266+
:config
258267
(setq neil-prompt-for-version-p nil
259268
neil-inject-dep-to-project-p t))
260-
261-
;; by default it attempts to find "neil" somewhere in the $PATH,
262-
;; but you can set the executable explicitly, e.g.,
269+
270+
;; by default it attempts to find "neil" somewhere in the $PATH,
271+
;; but you can set the executable explicitly, e.g.,
263272
(setq neil-executable-path "neil-cmd")
264273
;; or:
265274
(setq neil-executable-path "clj -M:neil")
275+
;; see the full list of customizations below
266276
```
277+
For a built-in package.el manager you can install it from from [MELPA](https://melpa.org/#/neil) with `M-x package-install` or with `:ensure` keyword from `use-package`.
278+
279+
```emacs-lisp
280+
(use-package neil
281+
:defer t
282+
:ensure t
283+
:custom
284+
(neil-prompt-for-version-p nil)
285+
(neil-inject-dep-to-project-p t))
286+
```
287+
288+
### Usage
289+
290+
So far, neil.el provides a command `M-x neil-find-clojure-package` that searches for the packages (using `neil dep search`), and generates a dependency string for different Clojure project types.
291+
292+
### Customization
293+
294+
* `neil-prompt-for-version-p` (default `t`)
295+
296+
When non-nil, select from available versions of a lib. Otherwise, use the latest found.
297+
298+
* `neil-inject-dep-to-project-p` (default `nil`)
299+
300+
When non-nil, try to add library dependency to current project. Otherwise, simply store the dependency string in the `kill-ring'. Works only for deps.edn projects.
301+
302+
* `neil-executable-path` (default `nil`)
303+
304+
If nil, tries to find neil executable in the PATH. Otherwise uses the given value.
267305

268306

269307
## Github's Rate Limit

neil.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Otherwise, use the latest found."
2929
:group 'neil)
3030

3131
(defcustom neil-inject-dep-to-project-p nil
32-
"When non-til, try to add library dependency to current project.
32+
"When non-nil, try to add library dependency to current project.
3333
Otherwise, simply store the dependency string in the `kill-ring'.
3434
Works only for deps.edn projects."
3535
:type 'boolean

0 commit comments

Comments
 (0)