Skip to content

Commit ea17601

Browse files
committed
Remove tools/setup and update HACKING.rst
1 parent 5b9d71b commit ea17601

File tree

2 files changed

+18
-90
lines changed

2 files changed

+18
-90
lines changed

HACKING.rst

Lines changed: 18 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,34 @@
11
Hacking on Annotator
22
====================
33

4-
Quick setup for lazy people (on a Mac)
5-
--------------------------------------
6-
7-
::
8-
9-
$ ./tools/setup
10-
11-
Slower introduction for industrious people (and those on Linux/Windows)
12-
-----------------------------------------------------------------------
13-
14-
If you wish to develop Annotator, you'll need to have a working
15-
installation of `Node.js <http://nodejs.org/>`__ (v0.8.x). Once
16-
installed (on most systems Node comes bundled with
17-
`NPM <http://npmjs.org/>`__) you should run the following to install
18-
Annotator's development dependencies::
4+
If you wish to develop Annotator, you'll need to have a working installation of
5+
`Node.js <http://nodejs.org/>`__ (>= v0.10.x). Once installed (on most systems
6+
Node comes bundled with `NPM <http://npmjs.org/>`__) you should run the
7+
following to install Annotator's development dependencies::
198

209
$ npm install .
2110

22-
The Annotator source is found in ``src/``, and is written in
23-
CoffeeScript, which is a little language that compiles to Javascript.
24-
See the `CoffeeScript website <http://coffeescript.org/>`__ for more
25-
information.
26-
27-
``dev.html`` loads the raw development files from ``lib/`` and can be
28-
useful when developing.
11+
The Annotator source is found in ``src/``. You can use the ``tools/serve``
12+
script while developing to serve bundle the source files. ``dev.html`` can be useful
13+
when developing.
2914

30-
The tests can be found in ``test/spec/``. You can run the tests in your
31-
browser (using ``test/runner.html``), but while you're working it's
32-
probably easiest to run the tests using ``npm test`` from the root of
33-
the repository. This will require
34-
`PhantomJS <http://www.phantomjs.org/>`__ and the mocha runner::
15+
The tests can be found in ``test/`` and can be run with::
3516

36-
$ npm install -g phantomjs mocha-phantomjs
17+
$ npm test
3718

38-
For inline documentation we use `TomDoc <http://tomdoc.org/>`__. It's a
39-
Ruby specification but it also works nicely with CoffeeScript.
4019

41-
Tools
20+
Build
4221
-----
4322

44-
There are a number of useful development tools shipped in the ``tools/``
45-
directory::
23+
Building the packaged version of Annotator involves running the appropriate
24+
``make`` task. To build everything, run::
25+
26+
$ make
4627

47-
$ ./tools/build # compiles src/*.coffee and test/*.coffee into lib/*.js
48-
$ ./tools/watch # like the above, but automatically recompiles files when they change
49-
$ ./tools/test # runs the test suite with PhantomJS
28+
To build just the main Annotator bundle, run::
5029

51-
Building the packaged version of Annotator involves running the
52-
appropriate ``make`` task. For example::
30+
$ make pkg/annotator.min.js
5331

54-
$ make # build everything
55-
$ make bookmarklet # build the bookmarklet
56-
$ make annotator plugins # build annotator and individual plugin files.
32+
To build a standalone extension module, run::
5733

34+
$ make pkg/annotator.document.min.js

tools/setup

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)