Skip to content

Commit

Permalink
Update installation steps for README
Browse files Browse the repository at this point in the history
  • Loading branch information
maxwellmattryan committed Oct 26, 2024
1 parent 088aa45 commit bf13766
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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:
Expand Down

0 comments on commit bf13766

Please sign in to comment.