Add getting started info

exa04 · May 29, 2024 · 015aa42 · 015aa42
1 parent 8d3ea7a
commit 015aa42
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/book/src/getting_started.md b/book/src/getting_started.md
@@ -1 +1,14 @@
 # Getting Started
+
+Cyma is intended for use with nih-plug and VIZIA. To get started, just add
+it to your `Cargo.toml`.
+
+```diff
+  [dependencies]
+  nih_plug = { ... }
+  nih_plug_vizia = { ... }
++ cyma = { git = "https://github.com/223230/cyma" }
+```
+
+Then, you can use Cyma where you need it, by using ```cyma::prelude::*```. This
+will import the most important parts of Cyma.