From 060ec94e3462b39eccff88da105351927bfbfaed Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Mon, 6 Nov 2023 00:42:44 +0000 Subject: [PATCH] Update installation docs --- docs/getting-started.md | 14 ++++++++++++++ docs/index.md | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 docs/getting-started.md diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000..656a979b --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,14 @@ +# Getting started + +## Requirements + +SignalFlow supports macOS, Linux (including Raspberry Pi), and has alpha support for Windows. + +## Installation + + - [Installing SignalFlow on macOS](installation/macos.md) + - [Installing SignalFlow on Linux](installation/linux.md) + +## Examples + +[Several example scripts](https://github.com/ideoforms/signalflow/tree/master/examples/python) are included within the repo, covering simple control and modulation, FM synthesis, sample granulation, MIDI control, chaotic functions, etc. diff --git a/docs/index.md b/docs/index.md index a35a4366..61eef92f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,5 +56,5 @@ In subsequent examples, we will skip the `import` line and assume you have alrea ## Documentation -- [Installation](installation/index) +- [Installation](getting-started/) - [Example code](http://github.com/ideoforms/signalflow/tree/master/examples/python)