From 6ffdfc009f556b70be80d595e916005c21a4cb86 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Fri, 23 Sep 2022 16:11:17 +0200 Subject: [PATCH] Update readme --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 2e6ab139..ca5d5942 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,15 @@ [![Tests](https://github.com/robbert-vdh/nih-plug/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/robbert-vdh/nih-plug/actions/workflows/test.yml?query=branch%3Amaster) [![Docs](https://github.com/robbert-vdh/nih-plug/actions/workflows/docs.yml/badge.svg?branch=master)](https://nih-plug.robbertvanderhelm.nl/) -This is a work in progress API-agnostic audio plugin framework written in Rust -as well as a small collection of plugins. The idea is to have a stateful but -simple plugin API that gets rid of as much unnecessary ceremony wherever -possible, while also keeping the amount of magic to minimum. Since this is not -quite meant for general use just yet, the plugin API surface is currently -limited to the functionality that I either needed myself or that was requested -by others. See the [current features](#current-features) section for more -information on the project's current status. +NIH-plug is an API-agnostic audio plugin framework written in Rust, as well as a +small collection of plugins. The idea is to have a stateful yet simple plugin +API that gets rid of as much unnecessary ceremony wherever possible, while also +keeping the amount of magic to minimum and making it easy to experiment with +different approaches to things. See the [current features](#current-features) +section for more information on the project's current status. Come join us on the [Rust Audio Discord](https://discord.gg/ykxU3rt4Cb), check -out the work-in-progress -[documentation](https://nih-plug.robbertvanderhelm.nl/), or use the +out the [documentation](https://nih-plug.robbertvanderhelm.nl/), or use the [cookiecutter template](https://github.com/robbert-vdh/nih-plug-template) to quickly get started with NIH-plug. @@ -31,14 +28,18 @@ quickly get started with NIH-plug. ## Plugins -Check each plugin's readme for more details on what the plugin actually does. -You can download the development binaries for Linux, Windows and macOS from the -[automated +Check each plugin's readme file for more details on what the plugin actually +does. You can download the development binaries for Linux, Windows and macOS +from the [automated builds](https://github.com/robbert-vdh/nih-plug/actions/workflows/build.yml?query=branch%3Amaster) page. Or if you're not signed in on GitHub, then you can also find the latest -nightly build [here](https://nightly.link/robbert-vdh/nih-plug/workflows/build/master). +nightly build +[here](https://nightly.link/robbert-vdh/nih-plug/workflows/build/master). You +may need to [disable gatekeeper]([disable +Gatekeeper](https://disable-gatekeeper.github.io/)) on macOS to be able to use +the plugins. -Scroll down for more information on the plugin framework. +Scroll down for more information on the underlying plugin framework. - [**Crisp**](plugins/crisp) adds a bright crispy top end to any low bass sound. Inspired by Polarity's [Fake Distortion](https://youtu.be/MKfFn4L1zeg) video.