aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnthony Wang2023-03-16 22:59:41 -0400
committerAnthony Wang2023-03-16 22:59:41 -0400
commit0da46c8a33e7a9b61b564cce5c4c4526fe3d84dc (patch)
tree1c3948cdb3a6cd6119f2ede76279cde26e464eba /README.md
parent46911993234b7c9cc07546f56843b35621b7f811 (diff)
Clean up code and rename to yue
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 5 insertions, 10 deletions
diff --git a/README.md b/README.md
index eb1259f..87fbaae 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,9 @@
-# Lambeat
-Lambeat is a new way to make music using functional programming. It's heavily influenced by [Bytebeat](https://dollchan.net/bytebeat) and initially started out as an reimplementation of Bytebeat in Scheme. Since then, it's grown to be a delightful new way to make music with code.
+# yue
+
+yue is a programmatic music library, influenced by [Bytebeat](https://dollchan.net/bytebeat). It is designed to be low-level and enable you to build your own abstractions and functions. Think of it like an assembly language for music. There are three implementations in Python (PyPy recommended for speed), Scheme, and Nim. Check out this [sample code](blend.py) and [listen to it](blend.ogg)!
## Get started
-First, install [Sox](https://sox.sourceforge.net/) and clone this repo. Write some music in `music.scm`. Enjoy your music with `guile --fresh-auto-compile lambeat.scm | play -r 8000 -t s16 -`!
-For the Python version, use `pypy3 music.py | play -r 44100 -t s32 -` to listen and `pypy3 music.py | sox -r 44100 -t s32 - example.ogg` to save to a file.
+First, install [Sox](https://sox.sourceforge.net/) and clone this repo.
-For the nim version
-```
-nim c --mm:orc -d:release music.nim
-./music > music.s32
-play -r 44100 -t s32 music.s32
-```
+To run a program that uses yue, use `pypy file.py`, `guile --fresh-auto-compile file.scm`, or `nim c --mm:orc -d:release file.nim && ./file`, and pipe to `play -r 44100 -t s32 -`. If you would like to save to a file, pipe to `sox -r 44100 -t s32 - file.ogg` instead.