Refactor clojure layer README

This commit is contained in:
syl20bnr 2014-12-11 19:43:03 -05:00
parent fe6e89df6e
commit ee514e60b2

View file

@ -2,21 +2,34 @@
![logo](clojure.png)
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
**Table of Contents**
- [Clojure contribution layer for Spacemacs](#clojure-contribution-layer-for-spacemacs)
- [Description](#description)
- [Packages Included](#packages-included)
- [Install](#install)
- [Cider](#cider)
- [Key Bindings](#key-bindings)
- [Documentation](#documentation)
- [Evaluation](#evaluation)
- [Goto](#goto)
- [REPL](#repl)
- [Tests](#tests)
<!-- markdown-toc end -->
## Description
This layer adds support for [Clojure](http://clojure.org) language using [Cider](https://github.com/clojure-emacs/cider)
Cider requires nRepl middleware to function, please check the installation instructions at https://github.com/clojure-emacs/cider
This layer adds support for [Clojure][] language using [Cider][]
## Packages Included
- [Cider](https://github.com/clojure-emacs/cider)
- [Cider][]
- [clojure-mode](https://github.com/clojure-emacs/clojure-mode)
- [Clj Refactor](https://github.com/clojure-emacs/clj-refactor.el)
- [Cider Auto Complete](https://github.com/clojure-emacs/ac-cider)
## Install
To use this contribution add it to your `~/.spacemacs`
@ -27,23 +40,50 @@ To use this contribution add it to your `~/.spacemacs`
)
```
### Cider
Cider requires nRepl middleware to function, please check the installation
instructions at the [cider repository](https://github.com/clojure-emacs/cider).
## Key Bindings
### Folding (js2-mode)
### Documentation
Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC m d d</kbd> | cider-doc
<kbd>SPC m d g</kbd> | cider-grimoire
<kbd>SPC m d j</kbd> | cider javadoc
### Evaluation
Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC m e b</kbd> | eval buffer
<kbd>SPC m e r</kbd> | eval region
<kbd>SPC m e s</kbd> | eval last sexp
### Goto
Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC m g v</kbd> | goto var
<kbd>SPC m g e</kbd> | goto error
<kbd>SPC m g s</kbd> | goto symbol
### REPL
Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC m j</kbd> | cider jack in
<kbd>SPC m k</kbd> | cider load-buffer
<kbd>SPC m z</kbd> | switch to repl
<kbd>SPC m d d</kbd> | cider-doc
<kbd>SPC m d g</kbd> | cider-grimoire
<kbd>SPC m d j</kbd> | cider javadoc
<kbd>SPC m e b</kbd> | eval buffer
<kbd>SPC m e r</kbd> | eval region
<kbd>SPC m e s</kbd> | eval last sexp
<kbd>SPC m g v</kbd> | goto var
<kbd>SPC m g e</kbd> | goto error
<kbd>SPC m g s</kbd> | goto symbol
### Tests
Key Binding | Description
----------------------|------------------------------------------------------------
<kbd>SPC m t t</kbd> | run tests
[Clojure]: http://clojure.org
[Cider]: https://github.com/clojure-emacs/cider