Skip to content

Commit 91032fc

Browse files
Git conflicts resolved
2 parents 24addee + 6d30eaf commit 91032fc

File tree

1 file changed

+44
-7
lines changed

1 file changed

+44
-7
lines changed

inc/lib/codemirror/README.md

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,49 @@
11
# CodeMirror
2+
23
[![Build Status](https://travis-ci.org/codemirror/CodeMirror.svg)](https://travis-ci.org/codemirror/CodeMirror)
3-
[![NPM version](https://img.shields.io/npm/v/codemirror.svg)](https://www.npmjs.org/package/codemirror)
4+
[![NPM version](https://img.shields.io/npm/v/codemirror.svg)](https://www.npmjs.org/package/codemirror)
5+
[![Join the chat at https://gitter.im/codemirror/CodeMirror](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/codemirror/CodeMirror)
46
[Funding status: ![maintainer happiness](https://marijnhaverbeke.nl/fund/status_s.png?again)](https://marijnhaverbeke.nl/fund/)
57

6-
CodeMirror is a JavaScript component that provides a code editor in
7-
the browser. When a mode is available for the language you are coding
8-
in, it will color your code, and optionally help with indentation.
8+
CodeMirror is a versatile text editor implemented in JavaScript for
9+
the browser. It is specialized for editing code, and comes with over
10+
100 language modes and various addons that implement more advanced
11+
editing functionality. Every language comes with fully-featured code
12+
and syntax highlighting to help with reading and editing complex code.
13+
14+
A rich programming API and a CSS theming system are available for
15+
customizing CodeMirror to fit your application, and extending it with
16+
new functionality.
17+
18+
You can find more information (and the
19+
[manual](http://codemirror.net/doc/manual.html)) on the [project
20+
page](http://codemirror.net). For questions and discussion, use the
21+
[discussion forum](https://discuss.codemirror.net/).
22+
23+
See
24+
[CONTRIBUTING.md](https://github.com/codemirror/CodeMirror/blob/master/CONTRIBUTING.md)
25+
for contributing guidelines.
26+
27+
The CodeMirror community aims to be welcoming to everybody. We use the
28+
[Contributor Covenant
29+
(1.1)](http://contributor-covenant.org/version/1/1/0/) as our code of
30+
conduct.
31+
32+
### Installation
33+
34+
Either get the [zip file](https://codemirror.net/codemirror.zip) with
35+
the latest version, or make sure you have [Node](https://nodejs.org/)
36+
installed and run:
37+
38+
npm install codemirror
39+
40+
**NOTE**: This is the source repository for the library, and not the
41+
distribution channel. Cloning it is not the recommended way to install
42+
the library, and will in fact not work unless you also run the build
43+
step.
44+
45+
### Quickstart
946

10-
The project page is http://codemirror.net
11-
The manual is at http://codemirror.net/doc/manual.html
12-
The contributing guidelines are in [CONTRIBUTING.md](https://github.com/codemirror/CodeMirror/blob/master/CONTRIBUTING.md)
47+
To build the project, make sure you have Node.js installed (at least version 6)
48+
and then `npm install`. To run, just open `index.html` in your
49+
browser (you don't need to run a webserver). Run the tests with `npm test`.

0 commit comments

Comments
 (0)