Update README.md
Browse files
README.md
CHANGED
|
@@ -1,12 +1,32 @@
|
|
| 1 |
---
|
| 2 |
-
title: Fairyland
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: docker
|
|
|
|
|
|
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
-
short_description: Fairyland is a magical web synth!
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Fairyland Web Synth
|
| 3 |
+
emoji: 🎹
|
| 4 |
+
colorFrom: pink
|
| 5 |
+
colorTo: purple
|
| 6 |
sdk: docker
|
| 7 |
+
sdk_version: "1.0"
|
| 8 |
+
app_file: Dockerfile
|
| 9 |
pinned: false
|
| 10 |
license: mit
|
|
|
|
| 11 |
---
|
| 12 |
|
| 13 |
+
# Fairyland Web Synth
|
| 14 |
+
|
| 15 |
+
A magical Next.js-based web synth built with Tone.js that features forest ambience, delay, reverb, and other enchanting effects.
|
| 16 |
+
|
| 17 |
+
## Overview
|
| 18 |
+
|
| 19 |
+
This project is deployed as a Docker-based Hugging Face Space. It leverages:
|
| 20 |
+
- **Next.js** for the frontend
|
| 21 |
+
- **Tone.js** for synthesis and audio effects
|
| 22 |
+
- **Git LFS** for managing large audio files (e.g. the forest ambience sample)
|
| 23 |
+
|
| 24 |
+
## How to Use
|
| 25 |
+
|
| 26 |
+
- **On-screen Keys**: Click on the buttons or press A, S, D, F, G, H, J, K to play the scale.
|
| 27 |
+
- **Controls**: Adjust the scale, root note, octave, ADSR envelope, and effects like delay and reverb.
|
| 28 |
+
- **Forest Ambience**: Toggle the forest pad on/off to immerse yourself in a woodland soundscape.
|
| 29 |
+
|
| 30 |
+
For more details, check out the [Spaces configuration reference](https://huggingface.co/docs/hub/spaces-config-reference).
|
| 31 |
+
|
| 32 |
+
Enjoy your journey into Fairyland!
|