Skip to content

Commit fa686c0

Browse files
committed
update readme
1 parent ad9056c commit fa686c0

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed

Readme.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,39 @@ Getting the code
3232

3333
Ace is a community project. We actively encourage and support contributions. The Ace source code is hosted on GitHub. It is released under the Mozilla tri-license (MPL/GPL/LGPL). This is the same license used by Firefox. This license is friendly to all kinds of projects, whether open source or not. Take charge of your editor and add your favorite language highlighting and keybindings!
3434

35-
git clone git://github.com/ajaxorg/ace.git
35+
git clone git://github.com/ajaxorg/ace.git
36+
git submodule update --init --recursive
37+
38+
Running Ace
39+
-----------
40+
41+
After the checkout Ace works out of the box. No build step is required. Simply open 'editor.html' in any browser except Google Chrome. Google Chrome doesn't allow XMLHTTPRequests from files loaded from disc (i.e. with a file:/// URL). To open the Ace in Chrome simply start the bundled mini HTTP server:
42+
43+
./static.py
44+
45+
The editor can then be opened at http://localhost:9999/editor.html.
46+
47+
Package Ace
48+
-----------
49+
50+
To package Ace we use the dryice build tool developed by the Mozilla Skywriter team. To install dryice and all its dependencies simply call:
51+
52+
npm link .
53+
54+
Afterwards Ace can by build by calling
55+
56+
./Makefile.dryice.js
57+
58+
The packaged Ace will be put in the 'build' folder.
59+
60+
Running the Unit Tests
61+
----------------------
62+
63+
The Ace unit tests run on node.js. Before the first run a couple of node mudules have to be installed. The easiest way to do this is by using the node package manager (npm). In the Ace base directory simply call
64+
65+
npm link .
66+
67+
To run the tests call:
68+
69+
node lib/ace/test/all.js
70+

static.py

100644100755
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#!/usr/bin/env python2.4
1+
#!/usr/bin/env python
22
"""static - A stupidly simple WSGI way to serve static (or mixed) content.
33
44
(See the docstrings of the various functions and classes.)

0 commit comments

Comments
 (0)