Skip to content

Commit da96575

Browse files
authored
[Docs] Updated README
Updated README to include links to full documentation and improved clarity in examples.
1 parent a3d1d12 commit da96575

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ DryWetMIDI is the .NET library to work with MIDI data and MIDI devices. It allow
2424
* Build musical compositions (see [Pattern](https://melanchall.github.io/drywetmidi/articles/composing/Pattern.html) page of the library docs) and use music theory API (see [Music Theory - Overview](https://melanchall.github.io/drywetmidi/articles/music-theory/Overview.html) article).
2525
* Perform complex tasks like quantizing, notes splitting or converting MIDI file to CSV representation (see [Tools](https://melanchall.github.io/drywetmidi/articles/tools/Overview.html) page of the library docs).
2626

27-
Please see [Getting started](#getting-started) section below for quick jump into the library.
27+
Please see [Getting started](#getting-started) section below for quick jump into the library. Or you can dive into the [full documentation](https://melanchall.github.io/drywetmidi).
2828

2929
> [!WARNING]
3030
> If you want to create an issue or a discussion, read this article first – [Support](https://melanchall.github.io/drywetmidi/articles/dev/Support.html).
@@ -52,9 +52,9 @@ If you find that DryWetMIDI has been useful for your project, please put a link
5252

5353
## Getting Started
5454

55-
Let's see small examples of what you can do with the library.
55+
Let's see small examples of what you can do with the library. Full docs available [here](https://melanchall.github.io/drywetmidi).
5656

57-
It's possible to [read a MIDI file](https://melanchall.github.io/drywetmidi/articles/file-reading-writing/MIDI-file-reading.html), then [collect all notes](https://melanchall.github.io/drywetmidi/articles/high-level-managing/Getting-objects.html) from it and print their time and length in the [metric](https://melanchall.github.io/drywetmidi/articles/high-level-managing/Time-and-length.html) (hours, minutes, second, ...) format:
57+
Simple task: [read a MIDI file](https://melanchall.github.io/drywetmidi/articles/file-reading-writing/MIDI-file-reading.html), then [collect all notes](https://melanchall.github.io/drywetmidi/articles/high-level-managing/Getting-objects.html) from it and print their times and lengths in the [metric](https://melanchall.github.io/drywetmidi/articles/high-level-managing/Time-and-length.html) (hours, minutes, second, ...) format:
5858

5959
```csharp
6060
var midiFile = MidiFile.Read("MyFile.mid");
@@ -133,4 +133,4 @@ var midiFile = pattern.ToFile(TempoMap.Create(Tempo.FromBeatsPerMinute(240)));
133133
midiFile.Write("DrumPattern.mid");
134134
```
135135

136-
Also you can check out sample applications from [CIRCE-EYES](https://github.com/CIRCE-EYES) (see the profile, VB.NET is used)
136+
Also you can check out sample applications from [CIRCE-EYES](https://github.com/CIRCE-EYES) (see the profile, VB.NET is used)

0 commit comments

Comments
 (0)