Skip to content

Commit 437fc8d

Browse files
committed
Update README
1 parent d658690 commit 437fc8d

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
This library renders a subset of [ABC Music Notation](http://abcnotation.com/) in Unity. It is built on the [ABCSharp](https://github.com/matthewcpp/abcsharp) parsing library.
33

44
### Installation
5-
The easiest way to to use the library is to download the repo as a zip archive and place the extracted directory into your Assets folder. Optionally the repo can be included as a git submodule in your project.
5+
The easiest way to to use the library is to install it using the Unity package manager.
66
This project requires the installation of the basic TextMeshPro asset package.
77

88
### Basic Usage
99
The included sample scene shows basic layout usage.
10-
The `ABCLayout` prefab serves as a top level container for all the sprites needed to display the score. The layout will attempt to fill as much as the area defined by the object's RectTransform.
10+
The `ABCLayout` prefab serves as a top level container for all the sprites needed to display the score. The layout will attempt to fill as the area defined by the object's RectTransform.
1111
Abc code is rendering using the `LoadString`, `LoadStream`, or `LoadFile` methods on the `ABCUnity.Layout` class.
1212
Individual items can have their color set using the `SetItemColor` method.
1313

@@ -28,4 +28,14 @@ K:C
2828
```
2929
Appears in the game engine as:
3030

31-
[![score.png](https://i.postimg.cc/T1Fy1dCJ/score.png)](https://matthewcpp.github.io/assets/images/score.png)
31+
[![score.png](https://i.postimg.cc/T1Fy1dCJ/score.png)](https://matthewcpp.github.io/assets/images/score.png)
32+
33+
### Testing
34+
The test harness is loacated in the `Runtime/Tests/Test.unity` scene.
35+
Enter playmode and select the test which to run from the dropdown menu.
36+
Compare the output with the corresponding baseline file.
37+
38+
### Adding tests
39+
Create a new abc file in the `Runtime/Resources/Tests` folder that contains the test abc code. The file should be specified as `testname.abc.txt`.
40+
Add a new entry to the `testFiles` array in `Runtime/Tests/TestUi.cs`
41+
Create a new MuseScore file in the `Runtime/Tests/Baselines~` folder that correctly renders the functionality you are testing.

0 commit comments

Comments
 (0)