Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oakes committed Jan 4, 2023
1 parent 8aa4f7d commit e77ff49
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ A Clojure library for making music with edn data. It uses [Alda](https://github.

In addition to playing music, you can [export to mp3, wav, or midi](https://oakes.github.io/edna/clj/edna.core/export'e'.html) files, or even [export to a data URI](https://oakes.github.io/edna/clj/edna.core/edna-'g'data-uri.html) for playing on the web. With that, you can embed music in a [ClojureScript game](https://github.com/oakes/play-cljc) and the music will rebuild automatically when you edit it.

**NOTE:** OpenJDK 11 is required! Newer versions of the JDK removed the `com.sun.media.sound.*` classes.

You may be interested in a very similar library I made for Nim called [paramidi](https://github.com/paranim/paramidi).

## Getting Started

You can generate a new project with the [Clojure CLI Tool](https://clojure.org/guides/getting_started#_clojure_installer_and_cli_tools):
Expand All @@ -14,8 +18,6 @@ You can generate a new project with the [Clojure CLI Tool](https://clojure.org/g

It will contain a README with all the commands you need to use.

**NOTE:** OpenJDK 11 is required! Newer versions of the JDK removed the `com.sun.media.sound.*` classes.

## Documentation

* Check out [the example scores](https://github.com/oakes/edna/tree/master/examples)
Expand Down

0 comments on commit e77ff49

Please sign in to comment.