Skip to content

Commit e41543d

Browse files
axvraxvr
committed
Rebrand and initial tidying to the project README
1 parent fae5710 commit e41543d

File tree

2 files changed

+80
-81
lines changed

2 files changed

+80
-81
lines changed

‎LICENSE.txt renamed to ‎LICENSE

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1+
Clojure.vim is licenced under the same terms as Vim using the Vim Licence.
2+
3+
syntax/clojure.vim:
4+
5+
Copyright © 2008–2012, Meikel Brandmeyer <[email protected]>
6+
Copyright © 2007–2008, Toralf Wittner <[email protected]>
7+
8+
ftdetect/clojure.vim,
9+
ftplugin/clojure.vim,
10+
indent/clojure.vim:
11+
12+
Copyright © 2008–2012, Meikel Brandmeyer <[email protected]>
13+
14+
Modified and relicensed under the Vim License for distribution with Vim:
15+
16+
Copyright © 2013–2017, Sung Pae <[email protected]>
17+
18+
------------------------------------------------------------------------------
19+
120
VimClojure License
221
==================
322

4-
Copyright 2008-2012 (c) Meikel Brandmeyer.
23+
(Original license.)
24+
25+
Copyright © 2008–2012, Meikel Brandmeyer.
26+
527
All rights reserved.
628

729
Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,15 +41,16 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1941
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
2042
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2143
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23-
THE SOFTWARE.
44+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
45+
SOFTWARE.
46+
2447

2548
vim-clojure-static License
2649
==========================
2750

28-
Copyright 2013-2014 (c) Sung Pae.
51+
(Relicensed for distribution with Vim.)
2952

30-
Relicensed under the Vim License (below) for distribution with Vim.
53+
Copyright © 2013–2017, Sung Pae.
3154

3255
VIM LICENSE
3356

‎README.markdown renamed to ‎README.md

Lines changed: 52 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,27 @@
1+
# Clojure.vim
12

3+
[Vim][] runtime files for [Clojure][]. This is a fork of
4+
[vim-clojure-static][].
25

3-
o8o
4-
'"'
5-
oooo ooooooo ooo. .oo. .oo.
6-
`88. .8' `888 `888P"Y88bP"Y88b
7-
`88..8' 888 888 888 888
8-
`888' 888 888 888 888
9-
`8' o888oo888o o888o o888o
106

7+
## Installation
118

12-
oooo o8o
13-
`888 '"'
14-
.ooooo. 888 .ooooo. oooooooo oooo oooo d8b .ooooo.
15-
d88' `"Y8 888 d88' `88b`888`888 `888 `888""8Pd88' `88b
16-
888 888 888 888 888 888 888 888 888ooo888
17-
888 .o8 888 888 888 888 888 888 888 888 .o
18-
`Y8bod8P'o888o`Y8bod8P' 888 `V88V"V8P'd888b `Y8bod8P'
19-
888
20-
.o. 88P
21-
. `Y888P . o8o
22-
.o8 .o8 '"'
23-
.oooo.o.o888oo .oooo. .o888oooooo .ooooo.
24-
d88( "8 888 `P )88b 888 `888 d88' `"Y8
25-
`"Y88b. 888 .oP"888 888 888 888
26-
o. )88b 888 .d8( 888 888 . 888 888 .o8
27-
8""888P' "888"`Y888""8o "888"o888o`Y8bod8P'
28-
29-
30-
31-
Meikel Brandmeyer's excellent Clojure runtime files, extracted from the
32-
[VimClojure](http://www.vim.org/scripts/script.php?script_id=2501) project for
33-
use with alternate Clojure REPL plugins.
34-
35-
These files ship with Vim versions 7.3.803 and later, and are periodically
9+
These files ship with Vim version 7.3.803 and later and are periodically
3610
merged into the official Vim repository.
3711

38-
Installation
39-
============
40-
4112
If you are running an old version of Vim or if you would like to keep up with
42-
development, you can install this repository like a standard Vim plugin.
43-
44-
If you are unfamiliar with this process, refer to
45-
the [Pathogen](https://github.com/tpope/vim-pathogen) project.
13+
the latest changes, you can install this repository as you would any other Vim
14+
plugin.
4615

47-
Please make sure that the following options are set in your vimrc to enable
48-
all features:
16+
Make sure that the following options are set in your vimrc so that all
17+
features are enabled:
4918

5019
```vim
5120
syntax on
5221
filetype plugin indent on
5322
```
5423

55-
Features
56-
========
24+
## Features
5725

5826
* [Augmentable](#syntax-options) syntax highlighting for Clojure and
5927
ClojureScript buffers.
@@ -70,8 +38,10 @@ Features
7038
If you install this project as a plugin, `*.edn` files are recognized as a
7139
Clojure filetype, overriding the built-in declaration as `edif`.
7240

73-
Third Party Extensions
74-
======================
41+
<!--
42+
TODO: update and move to wiki pages.
43+
44+
## Third Party Extensions
7545
7646
* Rainbow Parentheses
7747
@@ -87,15 +57,16 @@ Third Party Extensions
8757
This is a reimplementation of the DynamicHighlighting feature from
8858
VimClojure.
8959
90-
Clojure REPL Plugins
91-
====================
60+
## Clojure REPL Plugins
9261
9362
If you would like to get more serious about programming in Clojure, consider
9463
using an interactive
9564
[Clojure REPL plugin](https://github.com/guns/vim-clojure-static/wiki/Clojure-REPL-Plugins).
65+
-->
66+
67+
## Configuration
9668

97-
Syntax Options
98-
==============
69+
### Syntax Options
9970

10071
Syntax highlighting for public vars from `clojure.core` is provided by
10172
default, but any symbol can be matched and highlighted by adding it to the
@@ -123,8 +94,7 @@ namespaces that have set `(:refer-clojure :only [])`.
12394
[`vim-clojure-highlight`](https://github.com/guns/vim-clojure-highlight) uses
12495
these variables to highlight extra vars when connected to a REPL.
12596

126-
Indent Options
127-
==============
97+
### Indent Options
12898

12999
Clojure indentation differs somewhat from traditional Lisps, due in part to
130100
the use of square and curly brackets, and otherwise by community convention.
@@ -134,7 +104,7 @@ offers a few configurable options, listed below.
134104
If the current vim does not include searchpairpos(), the indent script falls
135105
back to normal `'lisp'` indenting, and the following options are ignored.
136106

137-
### `g:clojure_maxlines`
107+
#### `g:clojure_maxlines`
138108

139109
Set maximum scan distance of searchpairpos(). Larger values trade performance
140110
for correctness when dealing with very long forms. A value of 0 will scan
@@ -145,7 +115,7 @@ without limits.
145115
let g:clojure_maxlines = 100
146116
```
147117

148-
### `g:clojure_fuzzy_indent`, `g:clojure_fuzzy_indent_patterns`, `g:clojure_fuzzy_indent_blacklist`
118+
#### `g:clojure_fuzzy_indent`, `g:clojure_fuzzy_indent_patterns`, `g:clojure_fuzzy_indent_blacklist`
149119

150120
The `'lispwords'` option is a list of comma-separated words that mark special
151121
forms whose subforms must be indented with two spaces.
@@ -186,7 +156,7 @@ Each candidate word is tested for special treatment in this order:
186156
3. Return true if word matches a pattern in `g:clojure_fuzzy_indent_patterns`
187157
4. Return false and indent normally otherwise
188158

189-
### `g:clojure_special_indent_words`
159+
#### `g:clojure_special_indent_words`
190160

191161
Some forms in Clojure are indented so that every subform is indented only
192162
two spaces, regardless of `'lispwords'`. If you have a custom construct that
@@ -198,7 +168,7 @@ the default list below.
198168
let g:clojure_special_indent_words = 'deftype,defrecord,reify,proxy,extend-type,extend-protocol,letfn'
199169
```
200170

201-
### `g:clojure_align_multiline_strings`
171+
#### `g:clojure_align_multiline_strings`
202172

203173
Align subsequent lines in multiline strings to the column after the opening
204174
quote, instead of the same column.
@@ -226,7 +196,7 @@ This option is off by default.
226196
let g:clojure_align_multiline_strings = 0
227197
```
228198

229-
### `g:clojure_align_subforms`
199+
#### `g:clojure_align_subforms`
230200

231201
By default, parenthesized compound forms that look like function calls and
232202
whose head subform is on its own line have subsequent subforms indented by
@@ -254,10 +224,9 @@ This option is off by default.
254224
let g:clojure_align_subforms = 0
255225
```
256226

257-
Development
258-
===========
227+
## Contribute!
259228

260-
Pull requests and patches are strongly encouraged!
229+
Pull requests are welcome!
261230

262231
A large portion of the syntax file is generated from Clojure code in
263232
`clj/src/`. Generation of vim code in this fashion is preferred over hand
@@ -266,31 +235,38 @@ crafting of the same.
266235
There is an incomplete syntax test suite in `clj/test/`. Any additions and
267236
improvements to these tests are highly appreciated.
268237

269-
License and Acknowledgements
270-
============================
271238

272-
Many thanks to [Meikel Brandmeyer](http://kotka.de/) for his excellent work on
273-
making Vim a first class Clojure editor.
239+
## Acknowledgements
274240

275-
Thanks to [Tim Pope](https://github.com/tpope/) for advice in #vim.
241+
Clojure.vim is a continuation of [vim-clojure-static][].
276242

277-
`syntax/clojure.vim`
243+
Vim-clojure-static was created by [Sung Pae](https://github.com/guns) using
244+
[Meikel Brandmeyer](http://kotka.de/)'s Clojure runtime files from the
245+
[VimClojure][] project for use with alternate Clojure REPL plugins.
278246

279-
* Copyright 2007-2008 (c) Toralf Wittner <[email protected]>
280-
* Copyright 2008-2012 (c) Meikel Brandmeyer <[email protected]>
247+
Thanks to [Tim Pope](https://github.com/tpope/) for advice in
248+
[#vim](https://www.vi-improved.org/).
281249

282-
`ftdetect/clojure.vim`,<br>
283-
`ftplugin/clojure.vim`,<br>
284-
`indent/clojure.vim`
285250

286-
* Copyright 2008-2012 (c) Meikel Brandmeyer <[email protected]>
251+
## License
287252

288-
Modified and relicensed under the Vim License for distribution with Vim:
253+
Clojure.vim is licensed under the [Vim
254+
License](http://vimdoc.sourceforge.net/htmldoc/uganda.html#license) for
255+
distribution with Vim.
289256

290-
* Copyright 2013-2014 (c) Sung Pae <[email protected]>
257+
- Copyright © 2013–2017, Sung Pae. <[email protected]>
258+
- Copyright © 2008–2012, Meikel Brandmeyer. <[email protected]>
259+
- Copyright © 2007–2008, Toralf Wittner. <[email protected]>
291260

292-
See LICENSE.txt for more information.
261+
See [LICENSE](https://github.com/clojure-vim/clojure.vim/blob/master/LICENSE)
262+
for more details.
293263

294-
<!--
295-
vim:ft=markdown:et:tw=78:
296-
-->
264+
265+
<!-- Links -->
266+
267+
[vim]: https://www.vim.org
268+
[vim-clojure-static]: https://github.com/guns/vim-clojure-static
269+
[vimclojure]: https://www.vim.org/scripts/script.php?script_id=2501
270+
[clojure]: https://clojure.org
271+
272+
<!-- vim: set tw=79 : -->

0 commit comments

Comments
 (0)