Update readme

This commit is contained in:
metalex9
2021-02-12 20:41:21 -06:00
parent 937fdf0537
commit 2f89f56e85

View File

@@ -1,3 +1,7 @@
# :exclamation: Archival notice
This was the original player for [Generative.fm](https://generative.fm). It was retired on February 12, 2021 and replaced by [generative-fm/play](https://github.com/generative-fm/play).
# generative.fm
A platform for playing [generative music](https://medium.com/@metalex9/introduction-to-generative-music-91e00e4dba11) in the browser.
@@ -10,26 +14,10 @@ https://generative.fm
This site uses [Tone.js](https://tonejs.github.io/) to play audio in the browser through the [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API).
#### Samples
Most of the samples are provided by the [Versilian Studios Chamber Orchestra 2 Community Edition](https://vis.versilstudios.com/vsco-community.html) and the [Versilian Community Sample Library](https://vis.versilstudios.com/vcsl.html). Other samples provided by the [Sonatina Symphonic Orchestra](https://github.com/peastman/sso). The [singing bowl samples](https://kasper.bandcamp.com/album/singing-bowls) were provided by [Kasper](https://kasper.bandcamp.com/). [Lo-Fi Hip-Hop Drum Kit samples are from ItsLucid](https://soundpacks.com/free-sound-packs/lo-fi-hip-hop-drum-kit/). All other samples were specially recorded for the site. Sample files can be found in the [generative-music/samples.generative.fm] repository.
### Music
Source code for the music generators can be found in the [generative-music/pieces-alex-bainter](https://github.com/generative-music/pieces-alex-bainter) repository.
## Release Schedule
See [milestones](https://github.com/generative-music/generative.fm/milestones) for scheduled releases and to see which features and bug fixes will be included in each.
## Issues and Feedback
Problems or general feedback can be reported [here on Github](https://github.com/generative-music/site/issues) or by sending an email to [alex@alexbainter.com](mailto:alex@alexbainter.com?subject="Generative.fm"). Thanks!
### Status
You can view which new features and bug fixes are currently planned, in progress, or waiting to be deployed to the site by visiting the [Generative.fm project board](https://github.com/orgs/generative-music/projects/2).
## Installation
You will need [Node.js](https://nodejs.org/en/) installed on your machine.
@@ -42,14 +30,7 @@ You will need [Node.js](https://nodejs.org/en/) installed on your machine.
### Local Sample Files
Requests for sample files from the generative.fm sample CDN are blocked, see [#38](https://github.com/generative-music/generative.fm/issues/38). In order to play music locally, you will need to follow these instructions:
1. Install the build prerequisites specified in [BUILD_README.md](https://github.com/generative-music/samples.generative.fm/blob/master/BUILD_README.md).
2. Clone the [generative-music/samples.generative.fm] repository to a directory adjacent to the one this project was cloned to.
3. Run `npm i`.
4. Run `npm run build:samples`.
This will create the sample files on your machine to be served during local development.
Requests for sample files from the generative.fm sample CDN are blocked, see [#38](https://github.com/generative-music/generative.fm/issues/38). In order to play music locally, you will need to follow the instructions for [building](https://github.com/generative-music/samples-alex-bainter#building) and [serving](https://github.com/generative-music/samples-alex-bainter#serving-locally-with-docker) the sample files.
## Contributing