From bf13766dc4b0cec922d0c44285f6b544775c17c1 Mon Sep 17 00:00:00 2001 From: Matthew Maxwell Date: Sat, 26 Oct 2024 16:32:45 -0500 Subject: [PATCH] Update installation steps for README --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a8597b1..f3a7109 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ # `bbx_audio` -[![Version: v0.1.0](https://img.shields.io/badge/Version-v0.1.0-blue.svg)](https://github.com/blackboxdsp/bbx_audio) [![Test](https://github.com/blackboxdsp/bbx_audio/actions/workflows/ci-test.yml/badge.svg)](https://github.com/blackboxdsp/bbx_audio/actions/workflows/ci-test.yml) +[![Version: v0.1.0](https://img.shields.io/badge/Version-v0.1.0-blue.svg)](https://github.com/blackboxdsp/bbx_audio) +[![License](https://img.shields.io/badge/License-MIT-yellow)](https://github.com/blackboxdsp/bbx_audio/blob/develop/LICENSE) > A collection of Rust crates for audio-related DSP operations 🧮 ## Setup -If you would like to "play in the sandbox", you will need to install some additional dependencies. +Setup is quite minimal except for a few required installations on Linux-based platforms. ### Linux @@ -16,6 +17,9 @@ Install the following packages: sudo apt install alsa libasound2-dev libssl-dev pkg-config ``` +:info: If you would like to use the `bbx_draw` crate for visualizations, follow the [instruction guide](https://guide.nannou.cc/getting_started/platform-specific_setup) to setup +[Nannou](https://nannou.cc/). + ## Running To run an example in the sandbox, use the following command: