Skip to content

Commit

Permalink
Rename references to Neon2/3 to Neon in repo documents
Browse files Browse the repository at this point in the history
  • Loading branch information
JRegimbal committed Jun 6, 2019
1 parent c227350 commit a3ebffa
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Contributing to Neon2
# Contributing to Neon

## Bugs

For reporting bugs to Neon2, please follow the process outlined on the
For reporting bugs to Neon, please follow the process outlined on the
[issues wiki page](https://github.com/DDMAL/Neon2/wiki/Issues).

## Branches and Naming
Expand All @@ -11,7 +11,7 @@ When developing a feature or fixing a bug or doing anything more substantial tha
create a *feature* or *fix* branch addressing it and create a pull request rather than committing directly to
`develop` or `master`.

Feature branches introduce new features to Neon2. Fix branches fix something not working. If an issue exists
Feature branches introduce new features to Neon. Fix branches fix something not working. If an issue exists
for the feature or branch, it is recommended to name the branch after the branch type followed by a forward slash
and the issue number. (e.g. if a branch is to introduce a feature described in issue number 20, the branch should
be named `feature/20`.)
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Neon3
Neon v3.0.0
=====
[![Build_Status](https://travis-ci.org/DDMAL/Neon2.svg?branch=master)](https://travis-ci.org/DDMAL/Neon2)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Expand All @@ -7,10 +7,10 @@ Neon3
**N**eume **E**ditor **ON**line.


Neon3 is a browser-based music notation editor written in JavaScript using the Verovio music engraving library. The editor can be used to manipulate digitally encoded early musical scores in square-note notation.
Neon is a browser-based music notation editor written in JavaScript using the Verovio music engraving library. The editor can be used to manipulate digitally encoded early musical scores in square-note notation.


Neon2 is a re-write of [Neon.JS](https://github.com/DDMAL/Neon.js) using a modified version of [Verovio](https://github.com/DDMAL/verovio) to render MEI-Neume files according to the MEI 4.0 specifications.
Neon is a re-write of [Neon.JS](https://github.com/DDMAL/Neon.js) using a modified version of [Verovio](https://github.com/DDMAL/verovio) to render MEI-Neume files according to the MEI 4.0 specifications.

Requirements
------------
Expand Down Expand Up @@ -41,12 +41,12 @@ yarn start
Instructions
-----------

Neon.js has two main modes: viewer and editor. To learn how to use both, [read the instructions on our wiki.](https://github.com/DDMAL/Neon2/wiki/Instructions)
Neon has two main modes: viewer and editor. To learn how to use both, [read the instructions on our wiki.](https://github.com/DDMAL/Neon2/wiki/Instructions)

Test
----

Follow the instructions from above first. The tests for Neon2 use [Selenium](https://docs.seleniumhq.org/) and so require a web browser ([Firefox](https://mozilla.org/firefox)) and its driver ([geckodriver](https://github.com/mozilla/geckodriver)).
Follow the instructions from above first. The tests for Neon use [Selenium](https://docs.seleniumhq.org/) and so require a web browser ([Firefox](https://mozilla.org/firefox)) and its driver ([geckodriver](https://github.com/mozilla/geckodriver)).
On Mac install these with Homebrew:
```
brew cask install firefox
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Neon2",
"name": "Neon",
"version": "3.0.0",
"description": "A web-based editor for correcting MEI-Neume files",
"main": "server.js",
Expand Down

0 comments on commit a3ebffa

Please sign in to comment.