Skip to content

Commit 2182b2e

Browse files
author
Mohit Muthanna Cheppudira
committed
Markdown README.
1 parent 090218a commit 2182b2e

File tree

2 files changed

+53
-44
lines changed

2 files changed

+53
-44
lines changed

README

-44
This file was deleted.

README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Vex Flow
2+
3+
A JavaScript library for rendering music notation.
4+
Copyright (c) 2010 Mohit Muthanna Cheppudira
5+
6+
## On The Web
7+
8+
* [VexFlow Home](http://vexflow.com)
9+
* [The VexFlow Tutorial](http://vexflow.com/docs/tutorial.html)
10+
* [VexTab Home](http://vextab.com)
11+
* [The VexTab Tutorial](http://vexflow.com/vextab/tutorial.html)
12+
13+
## To Contribute
14+
15+
* Send in your changes via a GitHub pull request.
16+
* Rebase early, rebase often.
17+
* Please include tests -- I will not commit changes that don't have
18+
accompanying tests.
19+
* Please use 2 spaces instead of tabs and wrap your lines at 80 columns.
20+
* Try to stick to the style conventions in the existing code. (It's not great,
21+
but it's what we have.)
22+
* Join the VexFlow Google Group at:
23+
https://groups.google.com/forum/?fromgroups#!forum/vexflow
24+
25+
## Prerequisites (for Developers)
26+
27+
For performing full builds, you need the following:
28+
29+
* JRE
30+
* Google Closure Compiler (included in support/)
31+
* SCons
32+
* git
33+
* zip
34+
35+
## Build Instructions
36+
37+
Build with:
38+
39+
$ scons
40+
41+
Clean with:
42+
43+
$ scons -c
44+
45+
Quiet build:
46+
47+
$ scons -Q
48+
49+
## Links
50+
51+
The site: http://www.vexflow.com
52+
The blog: http://0xfe.blogspot.com
53+
The discussions: https://groups.google.com/forum/?fromgroups#!forum/vexflow

0 commit comments

Comments
 (0)