README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  out.width = "100%"
)

# Cannot add audio files in GitHub README, so let pkgdown use `index.md` 
# rather than `README.md` to generate the home page. The two differences:
# 
# <audio controls>
#   <source src="reference/figures/readme_audio.mp3" type="audio/mpeg">
# </audio>
# 
# See `vignette("gm")` for a complete guide to gm.
```


# gm <img src="man/figures/logo.png" align="right" alt="logo" width="120"/>

<!-- badges: start -->
<!-- badges: end -->

Create music with R.


## Example

```r
library(gm)

music <- 
  Music() +
  Meter(4, 4) +
  Line(c("C5", "D5", "E5", "F5"))
  
show(music)
```

![](man/figures/readme.png)

![](man/figures/readme_audio.png)


## Installation

Install gm:

``` r
install.packages("gm")

# Or install the development version from GitHub
pak::pak("flujoo/gm")
```

Install [MuseScore](https://musescore.org/). MuseScore is open source and free notation software.


## More

See [`vignette("gm")`](https://flujoo.github.io/gm/articles/gm.html) for a complete guide to gm.