From 236f30b88ed884994269ef8a92e541da17094bd4 Mon Sep 17 00:00:00 2001 From: lawl Date: Thu, 16 Jul 2020 16:42:51 +0200 Subject: [PATCH] Add instructions for missing PATH --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7568072..96f82c3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ - - # NoiseTorch [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) @@ -13,10 +11,6 @@ Don't forget to ~~like, comment and subscribe~~ leave a star ⭐ if this sounds ![](https://i.imgur.com/T2wH0bl.png) -Then simply select NoiseTorch as your microphone in any application. OBS, Mumble, Discord, anywhere. - -![](https://i.imgur.com/pG1GuBK.png) - ## Features * Two click setup of your virtual denoising microphone * A single, small, statically linked, self-contained binary @@ -30,7 +24,7 @@ Unpack the `tgz` file, into your home directory. tar -C $HOME -xzf NoiseTorch_x64.tgz This will unpack the application, icon and desktop entry to the correct place. -Depending on your desktop environment you may need to wait fo it to rescan for applications, or tell it to do a refresh now. +Depending on your desktop environment you may need to tell it to rescan for applications, or tell it to do a refresh now. With gnome this can be done with: @@ -38,6 +32,16 @@ With gnome this can be done with: You now have a `noisetorch` binary and desktop entry on your system. +If noisetorch doesn't start after installation, you may also have to make sure that `.local/bin` is in your PATH. On most distributions e.g. Ubuntu, this should be the case by default. If it's not, make sure to append + +``` +if [ -d "$HOME/.local/bin" ] ; then + PATH="$HOME/.local/bin:$PATH" +fi +``` + +to your `~/.profile`. + #### Uninstall rm .local/bin/noisetorch @@ -85,5 +89,4 @@ In `~/.config/noisetorch/config.toml` set `EnableUpdates = false`. * [xiph.org](https://xiph.org)/[Mozilla's](https://mozilla.org) excellent [RNNoise](https://jmvalin.ca/demo/rnnoise/). * [@werman](https://github.com/werman/)'s [LADSPA/VST wrapper](https://github.com/werman/noise-suppression-for-voice/) allowing us to load RNNoise into PulseAudio. -* [@aarzilli](https://github.com/aarzilli/)'s [nucular](https://github.com/aarzilli/nucular) GUI toolkit for Go. -* [Salee Design](www.salleedesign.com) (info@salleedesign.com)'s Microphone Icon under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) +* [@aarzilli](https://github.com/aarzilli/)'s [nucular](https://github.com/aarzilli/nucular) GUI toolkit for Go. \ No newline at end of file