From 46fc4636c42dd1ab4361f03010ada625d96b9a38 Mon Sep 17 00:00:00 2001
From: Hykilpikonna <me@hydev.org>
Date: Fri, 24 Mar 2023 19:45:03 -0400
Subject: [PATCH] [+] Readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..55cee6f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+<h1 align="center">
+  <br>
+  <br>
+  Open-KeyPrec
+  <h4 align="center">
+  Open-Sourced Electric Keyboard Percussion Instrument
+  </h4>
+  <h5 align="center">
+<a href="#code">Code</a>&nbsp;&nbsp;
+<a href="#build">Build</a>&nbsp;&nbsp;
+<a href="#usage">Usage</a>&nbsp;&nbsp;
+<a href="#license">License</a>
+</h5>
+  <br>
+  <br>
+  <br>
+</h1>
+
+## About
+
+Open-KeyPrec is an open-sourced, pressure-sensitive electric keyboard percussion (mallet) MIDI instrument. It has 61 keys, spanning 5 octaves of playing range from C2 to C7 like a standard Marimba. It also has a MIDI control panel with 16 buttons, 12 knobs (8 × 280° potentiometers and 4 × 360° rotary encoders).
+
+The sensors are controlled by an ESP32 development board, and the output is converted into a standard MIDI device. You can use audio workstation softwares like GarageBand or Reaper (or open-source alternatives like LMMS, Zrythm, or Ardour) to simulate the sounds of all kinds of different instruments.
+
+## Code
+
+**Source code structure**
+
+* `/src` - PC driver written in Rust
+* `/firmware` - ESP32 module firmware written in C++
+* `/circuits` - Printed circuit boards
+* `/models` - 3D-printable models
+
+**Toolchains & Environments Used**
+
+* EasyEDA: Web-editor for creating circuit boards
+* FreeCAD: Software for designing mechanical 3D models
+* CLion: IDE for Rust & C++
+* PlatformIO: Firmware development toolkit
+
+## Build
+
+### Materials Required
+
+!!!!!!!!!! TODO !!!!!!!!!!
+
+### Tools Required
+
+* FDM 3D Printer (~$300 Ender 3 is fine)
+* Soldering kit (iron, solder, flux)
+* Wood Saw
+* A computer
+
+### 1. Order PCBs
+
+!!!!!!!!!! TODO !!!!!!!!!!
+
+## Usage
+
+### Setup MIDI Device
+
+!!!!!!!!!! TODO !!!!!!!!!!
+
+### Setup Audio Softwares
+
+A MIDI keyboard doesn't make sound on its own. To actually play an instrument, you would need an audio workstation software and some VST sound sources.
+
+Notation: 🍎 - macOS, 🪟 - Windows, 🐧 - Linux
+
+#### Free Mallet Sound Sources
+
+**Built-in Sources**
+
+* GarageBand comes with marimba, vibraphone, and glockenspiel sound sources. It's free but macOS only and does not have VST support.
+* LMMS comes with several mallet instruments.
+
+**External Plugins**
+
+| Name & Link | Author | Platforms | Formats |
+| --- | --- | --- | --- |
+| [Alto Glockenspiel](https://www.steinberg.net/vst-instruments/alto-glockenspiel/) | Steinberg | 🍎 🪟 | VST, AU |
+| [Marimbaphonic](http://www.alanvista.com/marimbaphonic/) | Alan Vista | 🍎 🪟 | VST, AU |
+| [VibroMaster](http://www.alanvista.com/vibromaster/) | Alan Vista | 🍎 🪟 | VST, AU |
+| [DSK Virtuoso](https://www.dskmusic.com/dsk-virtuoso/) (Celesta, Glockenspiel, ...) | DSK Music | 🪟 | VST |
+
+Unfortunately there aren't any free VSTs supporting linux that I can find. You have to use Windows for this one if you don't have a mac/hackintosh. If you found any additional VSTs, feel free to make a PR!
+
+Other free VST Plugins: https://github.com/webprofusion/OpenAudio
\ No newline at end of file