onyx_online/voicemeeter-compact
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-compact.git synced 2024-11-22 04:40:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

add links in installation

Browse Source
This commit is contained in:
onyx-and-iris 2022-05-05 11:27:48 +01:00
parent f91a7d0d86
commit 7e42a708d2
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
INSTALLATION.md
View File

@ -10,6 +10,8 @@ If you don't have Python already you can fetch it easily from the Windows Store.
If you install Python straight from `python.org` instead remember to click 'Add Python environmental variables', this is important. If you install Python straight from `python.org` instead remember to click 'Add Python environmental variables', this is important.
## Download|Install Code
Once you have Python and Git for Windows installed you can simply download the source files (zip) directly with the green `Code` button, Once you have Python and Git for Windows installed you can simply download the source files (zip) directly with the green `Code` button,
![Image of Code button](./doc_imgs/codebutton.png) ![Image of Code button](./doc_imgs/codebutton.png)
@ -22,6 +24,8 @@ This will open a Powershell in the current directory.
Then use the command `pip install .` and wait for the required packages to install. Then use the command `pip install .` and wait for the required packages to install.
## Use
Finally, run the GUI with the command `pythonw .` Finally, run the GUI with the command `pythonw .`
If the GUI looks like the image below when you first load it, then no channels are labelled. From the menu, Profiles->Load Profile you may load an example config. Save your current Voicemeeter settings first :). If the GUI looks like the image below when you first load it, then no channels are labelled. From the menu, Profiles->Load Profile you may load an example config. Save your current Voicemeeter settings first :).
@ -31,4 +35,4 @@ If the GUI looks like the image below when you first load it, then no channels a
## Updates ## Updates
If there are updates to the app, you can track them in the [CHANGELOG](CHANGELOG.md), simply repeat the If there are updates to the app, you can track them in the [CHANGELOG](CHANGELOG.md), simply repeat the
steps above from the download with green `Code` button onwards. steps above from Download|Install Code onwards.

2
README.md
View File

@ -132,7 +132,7 @@ Configure as many vban connections as you wish. This allows the app to work over
For vban connections to work correctly VBAN TEXT incoming stream MUST be configured correctly on the remote machine. Both pcs ought to be connected to a local private network and should be able to ping one another. For vban connections to work correctly VBAN TEXT incoming stream MUST be configured correctly on the remote machine. Both pcs ought to be connected to a local private network and should be able to ping one another.
A valid vban.toml might look like this: A valid `vban.toml` might look like this:
```toml ```toml
[connection-1] [connection-1]