Skip to content

Commit 7ce149c

Browse files
committed
Merge pull request clojure-emacs#117 from bbatsov/readme-improvements
A bunch of smallish README improvements
2 parents ca86a89 + 4936ac1 commit 7ce149c

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Clojure Mode
22

33
Provides Emacs font-lock, indentation, and navigation for the
4-
[Clojure language](http://clojure.org).
4+
[Clojure programming language](http://clojure.org).
55

66
## Installation
77

@@ -13,7 +13,7 @@ MELPA has a development snapshot for users who don't mind breakage but
1313
don't want to run from a git checkout.
1414

1515
If you're not already using Marmalade, add this to your
16-
`~/.emacs.d/init.el` and load it with `M-x eval-buffer`.
16+
`~/.emacs.d/init.el` and load it with <kbd>M-x eval-buffer</kbd>.
1717

1818
```lisp
1919
(require 'package)
@@ -34,13 +34,13 @@ of code instead:
3434

3535
And then you can install:
3636

37-
`M-x package-refresh-contents`
38-
`M-x package-install [RET] clojure-mode [RET]`
37+
<kbd>M-x package-refresh-contents</kbd>
38+
<kbd>M-x package-install [RET] clojure-mode [RET]</kbd>
3939

4040
or if you'd rather keep it in your dotfiles:
4141

4242
```lisp
43-
(when (not (package-installed-p 'clojure-mode))
43+
(unless (package-installed-p 'clojure-mode)
4444
(package-refresh-contents)
4545
(package-install 'clojure-mode))
4646
```
@@ -59,10 +59,10 @@ instructions above should work for clojure-test-mode as well.
5959
(nrepl.el support is still in progress.)
6060

6161
Once you have a repl session active, you can run the tests in the
62-
current buffer with `C-c C-,`. Failing tests and errors will be
63-
highlighted using overlays. To clear the overlays, use `C-c k`.
62+
current buffer with <kbd>C-c C-,</kbd>. Failing tests and errors will be
63+
highlighted using overlays. To clear the overlays, use <kbd>C-c k</kbd>.
6464

65-
You can jump between implementation and test files with `C-c C-t` if
65+
You can jump between implementation and test files with <kbd>C-c C-t</kbd> if
6666
your project is laid out in a way that clojure-test-mode expects. Your
6767
project root should have a `src/` directory containing files that
6868
correspond to their namespace. It should also have a `test/` directory
@@ -76,15 +76,16 @@ its tests would be in `test/my/project/frob_test.clj` in the
7676

7777
## Paredit
7878

79-
Using clojure-mode with paredit is highly recommended. It is also
80-
available using package.el from the above archive.
79+
Using clojure-mode with
80+
[paredit](http://mumble.net/~campbell/emacs/paredit.el) is highly
81+
recommended. It is also available using package.el from the above
82+
archives.
8183

82-
Use paredit as you normally would with any other mode; for instance:
84+
Use paredit as you normally would any other minor mode; for instance:
8385

8486
```lisp
85-
;; (require 'paredit) if you didn't install via package.el
86-
(defun turn-on-paredit () (paredit-mode 1))
87-
(add-hook 'clojure-mode-hook 'turn-on-paredit)
87+
;; (require 'paredit) if you didn't install it via package.el
88+
(add-hook 'clojure-mode-hook 'paredit-mode)
8889
```
8990

9091
See [the cheat sheet](http://www.emacswiki.org/emacs/PareditCheatsheet)
@@ -124,7 +125,7 @@ SLIME support was removed in version 2.x in favor of `nrepl.el`.
124125

125126
## License
126127

127-
Copyright © 2007-2012 Jeffrey Chu, Lennart Staflin, Phil Hagelberg,
128+
Copyright © 2007-2013 Jeffrey Chu, Lennart Staflin, Phil Hagelberg,
128129
and [contributors](https://github.com/technomancy/clojure-mode/contributors).
129130

130-
Distributed under the GNU General Public License; see C-h t to view.
131+
Distributed under the GNU General Public License; type <kbd>C-h C-c</kbd> to view it.

0 commit comments

Comments
 (0)