README.md

This repository has been archived and is no longer maintained. You may be looking for Neon.

Neon.js

Neume Editor ONline.

Neon.js is a browser-based music notation editor written in JavaScript. The editor can be used to manipulate digitally encoded early musical scores in square-note notation.

You can see a demo of Neon.js in action here.

Requirements

• tornado: pip install tornado
• python bindings of the solesmesbuild branch of libmei available here.
  • Note: this requires the boost-python library. Installation instruction can be found here.

Setup

1. First, create a copy of the configuration file:

cp conf.py{.dist,}

2. Edit the configuration file conf.py and set MEI_DIRECTORY somewhere writable. Create 3 subdirectories in the MEI_DIRECTORY, undo, backup, and squarenote. Backup will store the original state of uploaded MEI files, which can be reverted to using the editor interface. Undo is for the undo feature. Squarenote is for storing the mei files of specific types.

3. Now compile the Neon.js code. Yes, compiling JavaScript. Weird, right?

make dist

This script downloads the latest google closure compiler and uses it to minify the Neon.js source code into the proper location.

4. Now, start up the server:

python server.py [port]

If no port is provided, the default port is 8080.

Visit the Neon.js web application at http://localhost:[port].

Usage

Make sure to checkout the built-in tutorial to familiarize yourself with Neon.js, which can be accessed from the homepage.

For more detailed information on all our functionality, please check our wiki pages at https://github.com/DDMAL/Neon.js/wiki

Development

Documentation is provided by jsdoc-toolkit

Build docs with (java required):

make doc

Tests

1. Client testing
   We're using Qunit for unit testing. Load test/neontest.html in a browser to run them.

2. Server testing
   To run server tests, install python-nose and run nosetests

License

Neon.js is distributed under the MIT license.