adding readme

This commit is contained in:
2023-07-28 16:23:54 +02:00
parent 3732adb6f0
commit 4deafa31dc

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Topos
Teletype inspired algorithmic sequencer for live coding in the browser. This is a prototype of an (hopefully) soon to be instrument that can generate sound through WebAudio and or MIDI.
# Installation / Dev
To run the application:
- clone the repository
- run `yarn install`
- run `yarn run dev`
# Keybindings
- `Ctrl+P`: start the audio playback/clock.
- `Ctrl+S`: stop the audio playback/clock.
- `Ctrl+G`: global buffer.
- `Ctrl+I`: initialisation buffer.
- `Ctrl+L`: local buffers.
- `F1...F9`: switch to one of the 9 local buffers.
To evaluate code, press `Ctrl+Enter` (no visible animation).