This repository has been archived by the owner on Mar 27, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #90 from RustAudio/readme-change
Update README.md: repo name change
- Loading branch information
Showing
2 changed files
with
15 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,17 @@ | ||
# rust-vst | ||
# vst-rs | ||
[![Travis Build][trav-img]][trav-url] | ||
[![Appveyor Build][appv-img]][appv-url] | ||
[![crates.io][crates-img]][crates-url] | ||
[![dependency status](https://deps.rs/repo/github/rust-dsp/rust-vst/status.svg)](https://deps.rs/repo/github/rust-dsp/rust-vst) | ||
[![Telegram Chat][tg-img]][tg-url] | ||
[![dependency status](https://deps.rs/repo/github/rustaudio/vst-rs/status.svg)](https://deps.rs/repo/github/rustaudio/vst-rs) | ||
[![Discord Chat][discord-img]][discord-url] | ||
[![Discourse topics][dc-img]][dc-url] | ||
|
||
rust-vst is a library for creating VST plugins in the Rust programming language. | ||
|
||
This library is a work in progress, and as such it does not yet implement all | ||
functionality. It can create basic VST plugins without an editor interface. | ||
|
||
For more detailed information about this library and subtopics such as GUI development progress, please check the [wiki](https://github.com/rust-dsp/rust-vst/wiki/). | ||
|
||
## Library Documentation | ||
* https://rust-dsp.github.io/rust-vst | ||
* https://rustaudio.github.io/vst-rs/vst/ | ||
|
||
## Community | ||
For questions, help, or other issues, consider joining our [Telegram Chat][tg-url]. | ||
|
@@ -27,15 +24,15 @@ For questions, help, or other issues, consider joining our [Telegram Chat][tg-ur | |
|
||
## Crate | ||
`VST` is available on [crates.io](https://crates.io/crates/vst). If you prefer the bleeding-edge, you can also | ||
include the crate directly from the official [Github repository](https://github.com/rust-dsp/rust-vst). | ||
include the crate directly from the official [Github repository](https://github.com/rustaudio/vst-rs). | ||
|
||
```toml | ||
# get from crates.io. | ||
vst = "0.1.0" | ||
``` | ||
```toml | ||
# get directly from Github. This might be unstable! | ||
vst = { git = "https://github.com/rust-dsp/rust-vst" } | ||
vst = { git = "https://github.com/rustaudio/vst-rs" } | ||
``` | ||
|
||
## Usage | ||
|
@@ -81,21 +78,19 @@ version = "0.0.1" | |
authors = ["Author <[email protected]>"] | ||
|
||
[dependencies] | ||
vst = { git = "https://github.com/rust-dsp/rust-vst" } | ||
vst = { git = "https://github.com/rustaudio/vst-rs" } | ||
|
||
[lib] | ||
name = "basicvst" | ||
crate-type = ["cdylib"] | ||
``` | ||
|
||
[trav-img]: https://travis-ci.org/rust-dsp/rust-vst.svg?branch=master | ||
[trav-url]: https://travis-ci.org/rust-dsp/rust-vst | ||
[appv-img]: https://ci.appveyor.com/api/projects/status/npiyjfithlx50hfs?svg=true | ||
[appv-url]: https://ci.appveyor.com/project/rustdsp/rust-vst | ||
[trav-img]: https://travis-ci.org/rustaudio/vst-rs.svg?branch=master | ||
[trav-url]: https://travis-ci.org/rustaudio/vst-rs | ||
[crates-img]: https://img.shields.io/crates/v/vst.svg | ||
[crates-url]: https://crates.io/crates/vst | ||
[tg-img]: https://img.shields.io/badge/Telegram-Join%20Chat-blue.svg | ||
[tg-url]: https://t.me/joinchat/BfEhnw0l4386Uzi5elmGrQ | ||
[discord-img]: https://img.shields.io/discord/590254806208217089.svg?label=Discord | ||
[discord-url]: https://discord.gg/QPdhk2u | ||
[dc-img]: https://img.shields.io/discourse/https/rust-audio.discourse.group/topics.svg | ||
[dc-url]: https://rust-audio.discourse.group | ||
|
||
|