From 015aa42efc83914dcb25e5616afe3215e20da131 Mon Sep 17 00:00:00 2001 From: luna <223230@proton.me> Date: Wed, 29 May 2024 10:28:15 +0200 Subject: [PATCH] Add getting started info --- book/src/getting_started.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/book/src/getting_started.md b/book/src/getting_started.md index bad5562..fd2c3c7 100644 --- 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. \ No newline at end of file