Skip to content

Commit

Permalink
V 0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
aminya committed Mar 4, 2020
1 parent 416ff98 commit 6a08b0c
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "MusicXML"
uuid = "521615e9-e573-4eb2-bc7e-702d55c0bb95"
authors = ["Amin Yahyaabadi"]
version = "0.2.2"
version = "0.3"

[deps]
AcuteML = "6b84a0a3-a11a-41fa-a417-e600528de108"
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,21 @@

Powerful MusicXML reading and writing package for Julia.

# Installation
# Installation and Usage
```julia
] add https://github.com/JuliaMusic/MusicXML.jl
using Pkg
Pkg.add("MusicXML")
```
```julia
using MusicXML
```

# Creating Example
```julia
@MX begin # adds `MX.` to the name of all MusicXML types
using MusicXML

@MX begin # adds `MX.` to the name of all MusicXML types

## Part List
### Piano
midiinstrument_piano = MidiInstrument(channel= 1, program =1, volume = 100, pan =0, id = "P1-I1")
Expand Down
3 changes: 2 additions & 1 deletion docs/src/creating.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Creating

```julia
@MX begin # adds `MX.` to the name of all MusicXML types
using MusicXML

@MX begin # adds `MX.` to the name of all MusicXML types

## Part List
### Piano
midiinstrument_piano = MidiInstrument(channel= 1, program =1, volume = 100, pan =0, id = "P1-I1")
Expand Down
10 changes: 7 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@ CurrentModule = MusicXML

Powerful MusicXML reading and writing package for Julia.

# Installation
# Installation and Usage
```julia
] add https://github.com/JuliaMusic/MusicXML.jl
using Pkg
Pkg.add("MusicXML")
```
```julia
using MusicXML
```

# Usage
See `Example` from sidebar for an example of MusicXML usage. Study `Types` and `IO` for more information.
Look into [Parsing Example](https://juliamusic.github.io/MusicXML.jl/dev/parsing.html) and [Creating Example](https://juliamusic.github.io/MusicXML.jl/dev/creating.html) for examples of MusicXML's usage. Study `Types` and `IO` for more information.

2 comments on commit 6a08b0c

@aminya
Copy link
Member Author

@aminya aminya commented on 6a08b0c Mar 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/10503

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if Julia TagBot is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 6a08b0c98b63cf107adc8094a7377dc6631ff3a8
git push origin v0.3.0

Please sign in to comment.