From 4deafa31dc3241d370690238de5ed40841ce019c Mon Sep 17 00:00:00 2001
From: Raphael Forment <raphael.forment@gmail.com>
Date: Fri, 28 Jul 2023 16:23:54 +0200
Subject: [PATCH] adding readme

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3785954
--- /dev/null
+++ b/README.md
@@ -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).