From 02223009ba43532e20b1d7e5d93859cfe16218c3 Mon Sep 17 00:00:00 2001
From: David Braun <2096055+DBraun@users.noreply.github.com>
Date: Thu, 9 Jan 2025 10:28:11 -0500
Subject: [PATCH] update README

---
 .github/workflows/all.yml | 2 ++
 README.md                 | 3 +++
 2 files changed, 5 insertions(+)

diff --git a/.github/workflows/all.yml b/.github/workflows/all.yml
index a133210..8d6caff 100644
--- a/.github/workflows/all.yml
+++ b/.github/workflows/all.yml
@@ -3,6 +3,8 @@ name: Python package
 on:
   push:
     branches: [ "main" ]
+    paths-ignore:
+      - "README.md"
   pull_request:
     branches: [ "main" ]
   release:
diff --git a/README.md b/README.md
index 7711ebf..8c72af8 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,7 @@ print("potential sources:", vita.get_modulation_sources())
 print("potential destinations:", vita.get_modulation_destinations())
 
 # "lfo_1" and "filter_1_cutoff" are potential sources and destinations.
+# Let's use "lfo_1" as a source and "filter_1_cutoff" as a destination.
 assert synth.connect_modulation("lfo_1", "filter_1_cutoff")
 
 controls = synth.get_controls()
@@ -69,6 +70,8 @@ synth.load_init_preset()
 synth.clear_modulations()
 ```
 
+Documentation is not yet automated. Please browse [bindings.cpp](https://github.com/DBraun/Vita/blob/main/src/headless/bindings.cpp) to get a sense of how the code works.
+
 ### Issues
 
 If you find any issues with the code, report them at https://github.com/DBraun/Vita.