Skip to content

Commit ba65ade

Browse files
committed
Various small improvements to the README
1 parent 8105d55 commit ba65ade

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,14 @@
99
A collection of [nREPL](https://github.com/nrepl/nrepl)
1010
middleware, originally designed to enhance
1111
[CIDER](https://github.com/clojure-emacs/cider).
12-
`cider-nrepl` is also used by [fireplace.vim](https://github.com/tpope/vim-fireplace), [vim-iced](https://github.com/liquidz/vim-iced),
13-
[Calva](https://calva.io/), [Conjure](https://github.com/Olical/conjure) and other Clojure development tools based on nREPL.
12+
`cider-nrepl` is also used:
13+
14+
- [fireplace.vim](https://github.com/tpope/vim-fireplace)
15+
- [vim-iced](https://github.com/liquidz/vim-iced)
16+
- [Calva](https://calva.io/)
17+
- [Conjure](https://github.com/Olical/conjure)
18+
19+
and other Clojure development tools based on nREPL.
1420

1521
If you're just a user trying to get started with CIDER, then you
1622
probably don't want to read this. You should follow the steps in
@@ -59,8 +65,9 @@ guidelines](.github/CONTRIBUTING.md).
5965

6066
### Local development
6167

62-
Local development tasks, like running the tests or locally installing cider-nrepl are offered by our Makefile.
63-
We recommend using it, since some aspects can be intricate to newcomers.
68+
Local development tasks, like running the tests or locally installing
69+
cider-nrepl are offered by our Makefile. We recommend using it, since some
70+
aspects (e.g. the use of [mranderson][]) can be intricate to newcomers.
6471

6572
These are its main tasks for local development:
6673

@@ -94,8 +101,10 @@ make docs
94101

95102
## Releasing to Clojars
96103

97-
**Note:** Make sure you've updated the changelog, `docs/antora.yml`, etc
98-
before cutting a new release.
104+
> [!IMPORTANT]
105+
>
106+
> Make sure you've updated the changelog, `docs/antora.yml`, etc
107+
> before cutting a new release.
99108
100109
Release to [clojars](https://clojars.org/) by tagging a new release:
101110

@@ -143,6 +152,4 @@ Distributed under the Eclipse Public License, the same as Clojure.
143152
[tools.namespace]: https://github.com/clojure/tools.namespace
144153
[clj-reload]: https://github.com/tonsky/clj-reload
145154
[cljfmt]: https://github.com/weavejester/cljfmt
146-
[vim-replant]: https://github.com/SevereOverfl0w/vim-replant
147-
[vim-fireplace]: https://github.com/tpope/vim-fireplace
148155
[mranderson]: https://github.com/benedekfazekas/mranderson

0 commit comments

Comments
 (0)