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

updates to readme, and installation instructions

Browse Source 
updates to readme, and installation instructions
This commit is contained in:
onyx-and-iris 2022-06-17 00:06:57 +01:00
parent 83d0598d84
commit 7f8a1a2ffc
2 changed files with 7 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
INSTALLATION.md
View File

@ -1,28 +1,20 @@
## Git Installation
https://gitforwindows.org/
## Python Installation ## Python Installation
If you don't have Python already you can fetch it easily from the Windows Store. Simply type `store` into the windows search bar, and select the latest version. At the time of writing that is Python 3.10. If you don't have Python already you can fetch it easily from the Windows Store. Simply type `store` into the windows search bar. To run this GUI you'll need the latest version, Python 3.11.0b3.
![Image of Python in Windows Store](./doc_imgs/wspython310.png)
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 ## 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 Python is installed:
![Image of Code button](./doc_imgs/codebutton.png) Enter voicemeeter-compact directory and type `powershell.exe` into the explorer bar as shown in the image below.
Once extracted enter voicemeeter-compact directory and type `powershell.exe` into the explorer bar as shown in the image below.
![Image of PS in Explorer](./doc_imgs/powershellinexplorerbar.png) ![Image of PS in Explorer](./doc_imgs/powershellinexplorerbar.png)
This will open a Powershell in the current directory. 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 voicemeeter-compact` and wait for the required packages to install.
## Use ## Use

7
README.md
View File

@ -62,9 +62,9 @@ A _kind_id_ specifies a major Voicemeeter version. This may be one of:
## TOML Files ## TOML Files
This is how your files should be organised. Wherever your `__main__.py` file is located (after install this can be any location), `config` and `profiles` directories This is how your files should be organised. Wherever your `__main__.py` file is located (after install this can be any location), `configs` should be in the same location.
should be in the same location. Directly inside of configs directory you may place an app.toml, vban.toml and a directory for each kind.
Regarding profiles, a directory for each kind should hold the profile files and in each there can be any number of config files. Example, a config for streaming, a config for general listening/movie watching or any other type of config. Inside each kind directory you may place as many custom toml configurations as you wish.
. .
@ -76,7 +76,6 @@ Regarding profiles, a directory for each kind should hold the profile files and
        ├── vban.toml         ├── vban.toml
├── profiles
        ├── basic         ├── basic