Browse Source

update README.md

main
James Fenn 2 months ago
parent
commit
8671ccb156
1 changed files with 25 additions and 2 deletions
  1. +25
    -2
      README.md

+ 25
- 2
README.md View File

@@ -1,7 +1,30 @@
# Audio Automation

This is a MIDI song generation library written in Kotlin for the JVM. It aims to allow for somewhat intuitive construction of generative / randomized "music," making use of [Kotlin Flows](https://kotlinlang.org/docs/reference/coroutines/flow.html) and coroutines.
This is a MIDI-focused song generation library written in Kotlin for the JVM. It aims to allow for somewhat intuitive construction of generative / randomized "music," making use of [Kotlin Flows](https://kotlinlang.org/docs/reference/coroutines/flow.html) and coroutines.

## Building
## Installation

The `:audio-automation` module is published on [JitPack](https://jitpack.io/#dev.horrific.code.james/audio-automation), which you can add to your project by copying the following to your root build.gradle at the end of "repositories".

```groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```

To add the dependency to a module, copy this line into your app's build.gradle file.

```groovy
implementation 'dev.horrific.code.james.audio-automation:audio-automation:$library_version'
```

## Usage

TODO: the API isn't finalized yet, so this section should be added later

## Development

Run `./gradlew :example:run` for a demo project.

Loading…
Cancel
Save