Skip to content

Commit c824c22

Browse files
committed
Add installation instructions to readme
1 parent 281651a commit c824c22

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@
55
[![Join the chat at https://gitter.im/codemirror/CodeMirror](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/codemirror/CodeMirror)
66
[Funding status: ![maintainer happiness](https://marijnhaverbeke.nl/fund/status_s.png?again)](https://marijnhaverbeke.nl/fund/)
77

8-
**NOTE**: This is the source repository for the library, and not the
9-
distribution channel. You need to run a build step if you want to use
10-
this code. To install the software pre-built, get it from
11-
[NPM](https://www.npmjs.com/package/codemirror) or [the
12-
website](https://codemirror.net/codemirror.zip).
13-
148
CodeMirror is a versatile text editor implemented in JavaScript for
159
the browser. It is specialized for editing code, and comes with over
1610
100 language modes and various addons that implement more advanced
@@ -35,6 +29,19 @@ The CodeMirror community aims to be welcoming to everybody. We use the
3529
(1.1)](http://contributor-covenant.org/version/1/1/0/) as our code of
3630
conduct.
3731

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+
3845
### Quickstart
3946

4047
To build the project, make sure you have Node.js installed (at least version 6)

0 commit comments

Comments
 (0)