Skip to content

Commit 1dc447a

Browse files
committed
Add installation and build instructions to the README
1 parent af6e899 commit 1dc447a

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1-
# 🎵 Godot-PureData
1+
# 🎵 Godot-Pure-Data
22

33
> **Godot libpd without rebuilding Godot.** Supports 🪟Windows(x86_x64), 🐧Linux(x86_x64), & 🍎macOS(x86_x64, aarch64).
44
55
This library works and is ready to use. But repo in progress. Hit me up with an issue.
6+
7+
## Downloading
8+
9+
For now, the best way to download this is downloading the `project` artifact of the latest CI build. Take a look at [this guide](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/downloading-workflow-artifacts) if you don't know how to do this. You will want the latest successful build from [this page](https://github.com/samsface/godot-pure-data/actions?query=event%3Apush+branch%3Amaster).
10+
11+
## Building from source
12+
13+
Most of the dependencies are bundled with the library as submodules. As long as you ran git clone with `--recurse-submodules` and you have CMake installed, you should just be able to run `dev.sh` to build.

0 commit comments

Comments
 (0)