diff --git a/README.md b/README.md index 8be96cc97acb1b015cd2d48624e68cd48e551198..527a23bddce4a409835a786e7bb9fdea4e8ad8a5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ # gdpd gdpd is a Godot add-on for loading and processing Pure Data patches. +The audio is played using Jack on GNU/Linux and CoreAudio on OSX. + + +The *master* branch is for Godot 4.X. +Use the Godot3 branch for previous versions. + # Using gdpd + +Install the gdpd folder in the addons folder of your Godot project. + + In a script, 1. Initialize gdpd ```python -@onready var _gdpd = load("res://addons/gdpd/bin/gdpd.gdns").new() +@onready var _gdpd = GdPd.new() ``` 2. Initialize the audio inputs and outputs