Browse files

Markdown README.

  • Loading branch information...
1 parent 090218a commit 2182b2e229d84aa05d5e5ff2449d8be61bbd65f3 Mohit Muthanna Cheppudira committed Mar 12, 2012
Showing with 53 additions and 44 deletions.
  1. +0 −44 README
  2. +53 −0 README.md
View
44 README
@@ -1,44 +0,0 @@
-Vex Flow - A JavaScript library for rendering music notation.
-Copyright (c) 2010 Mohit Muthanna Cheppudira
-
----------------
-
-Coders please note:
-
-- Send in your changes via a GitHub pull request.
-- Rebase early, rebase often.
-- Please include tests -- I will not commit changes that don't have
- accompanying tests.
-- Please use 2 spaces instead of tabs and wrap your lines at 80 columns.
-- Try to stick to the style conventions in the existing code. (It's not great,
- but it's what we have.)
-- Join the VexFlow Google Group at:
- https://groups.google.com/forum/?fromgroups#!forum/vexflow
-
-----------------
-
-For performing full builds, you need the following:
-
- - JRE
- - Google Closure Compiler (included in support/)
- - SCons
- - git
- - zip
-
-Build with:
-
- $ scons
-
-Clean with:
-
- $ scons -c
-
-Quiet build:
-
- $ scons -Q
-
-----------------
-
-The site: http://www.vexflow.com
-The blog: http://0xfe.blogspot.com
-The discussions: https://groups.google.com/forum/?fromgroups#!forum/vexflow
View
53 README.md
@@ -0,0 +1,53 @@
+# Vex Flow
+
+A JavaScript library for rendering music notation.
+Copyright (c) 2010 Mohit Muthanna Cheppudira
+
+## On The Web
+
+* [VexFlow Home](http://vexflow.com)
+* [The VexFlow Tutorial](http://vexflow.com/docs/tutorial.html)
+* [VexTab Home](http://vextab.com)
+* [The VexTab Tutorial](http://vexflow.com/vextab/tutorial.html)
+
+## To Contribute
+
+* Send in your changes via a GitHub pull request.
+* Rebase early, rebase often.
+* Please include tests -- I will not commit changes that don't have
+ accompanying tests.
+* Please use 2 spaces instead of tabs and wrap your lines at 80 columns.
+* Try to stick to the style conventions in the existing code. (It's not great,
+ but it's what we have.)
+* Join the VexFlow Google Group at:
+ https://groups.google.com/forum/?fromgroups#!forum/vexflow
+
+## Prerequisites (for Developers)
+
+For performing full builds, you need the following:
+
+* JRE
+* Google Closure Compiler (included in support/)
+* SCons
+* git
+* zip
+
+## Build Instructions
+
+Build with:
+
+ $ scons
+
+Clean with:
+
+ $ scons -c
+
+Quiet build:
+
+ $ scons -Q
+
+## Links
+
+The site: http://www.vexflow.com
+The blog: http://0xfe.blogspot.com
+The discussions: https://groups.google.com/forum/?fromgroups#!forum/vexflow

0 comments on commit 2182b2e

Please sign in to comment.