diff --git a/Project.toml b/Project.toml index adc78ee..e2e5b74 100644 --- a/Project.toml +++ b/Project.toml @@ -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" diff --git a/README.md b/README.md index 3063ac5..38c8835 100644 --- a/README.md +++ b/README.md @@ -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") diff --git a/docs/src/creating.md b/docs/src/creating.md index c3031a3..f0aad2d 100644 --- a/docs/src/creating.md +++ b/docs/src/creating.md @@ -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") diff --git a/docs/src/index.md b/docs/src/index.md index 74e963d..e688577 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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.