FIRST

README.md

@@ -0,0 +1,43 @@
+```markdown
+## noiseless-lv2 - LV2 wrapper for https://github.com/jneem/nnnoiseless (VRChat's neural noise canceller)
+
+This plugin lets you run VRChat's neural noise canceller as an LV2 plugin in Carla or any other host.
+
+### Features:
+
+* Real-time denoising of your mic input (or any audio stream).
+* Uses the same model as VRChat's built in voice denoiser.
+* Works on Linux (x86_64), Windows and MacOS.
+
+### Installation:
+
+**Requirements:**  
+Rust + cargo  
+LV2 headers (on Debian-based distros: sudo apt install lv2-dev)
+
+```
+git clone https://github.com/YOURNAME/noiseless-lv2.git && cd noiseless-lv2/
+cargo build --release
+mkdir -pv ~/.lv2/noiseless-lv2.lv2/
+cp target/release/libnoiseless_lv2.so ~/.lv2/noiseless-lv2.lv2/
+cp manifest.ttl denoise.ttl ~/.lv2/noiseless-lv2.lv2/
+```
+
+### Usage:
+
+Open up Carla or another LV2 host and add the "nnnoiseless Denoise" plugin from the LV2 list.
+Route your mic or noisy signal through it!
+
+**NOTE:** The plugin expects a sample rate of **48kHz**.
+If your system uses a different sample rate you'll need to resample before passing audio to the plugin.
+
+#### Example Carla Patchbay Setup:
+
+```
+Mic -> [Noiseless-LV2] -> Output / Discord / OBS etc...
+```
+
+Enjoy!
+```
+
+Let me know if you want a logo or screenshots etc...