Skip to content

Add acid.nvim info at README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2019
Merged

Add acid.nvim info at README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ from Meikel Brandmeyer's VimClojure project.
# Requires:

* [vim-clojure-static](https://github.com/guns/vim-clojure-static)
* [fireplace.vim](https://github.com/tpope/vim-fireplace)
* [acid.nvim](https://github.com/clojure-vim/acid.nvim)

While Vim ships with `vim-clojure-static`, this plugin uses a feature from a
very [recent version][].
Expand All @@ -36,16 +36,21 @@ create an issue! This can be done quite easily.
Install as a normal Vim plugin. If you are unfamiliar with this process,
please refer to [Pathogen](https://github.com/tpope/vim-pathogen).

Just make sure to refer to this branch on your configuration file.
```
Plug 'hkupty/async-clj-highlight', { 'for': 'clojure', 'branch': 'acid-autocmd' }
```

# Usage

`vim-clojure-highlight` installs an autocommand that detects and highlights
local vars, ns-refers, and aliased references every time a `*.clj` file
is (re)loaded. The syntax highlighting reflects the state of the REPL, so
unevaluated references remain unmatched.

This will fail silently if no fireplace nREPL sessions exist.
This will fail silently if no acid nREPL sessions exist.

Reload your buffer with `:e` after an eval to update syntax matches.
Reload your buffer with `:w` after an eval to update syntax matches.
Alternately, use the `:ClojureHighlightReferences` command in a custom
autocommand or mapping to do the same.

Expand Down