Skip to content

Commit e3803ac

Browse files
committed
[readme] add a table of contents and more info about contribuying
1 parent b6c7a73 commit e3803ac

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ A graphical user interface for configuring GPU related environment variables and
1212
![](/images/2.png)
1313
![](/images/3.png)
1414

15+
## Table of Contents
16+
17+
- [What you can do?](#what-you-can-do)
18+
- [Build/Test Requirements](#buildtest-requirements)
19+
- [Installation](#installation)
20+
- [Testing volt-gui](#testing-volt-gui)
21+
- [How to use volt-gui](#how-to-use-volt-gui)
22+
- [How to use the volt script](#how-to-use-the-volt-script)
23+
- [Render Selector explained](#render-selector-explained)
24+
- [Technical References](#technical-references)
25+
- [Contributing](#contributing)
26+
1527
## What you can do?:
1628

1729
- CPU Management
@@ -166,7 +178,7 @@ When using the terminal or a custom desktop entry:
166178
volt flatpak run net.pcsx2.PCSX2
167179
```
168180

169-
## GPU Selector explained:
181+
## Render Selector explained:
170182

171183
- `OpenGL Provider` Select a OpenGL provider between the NVIDIA Proprietary Drivers and Mesa Drivers.
172184
- `Mesa Select GPU` In this case “select” means the GPU will be first in the reported physical devices list, It applies to OpenGL and Vulkan and only GPUs using the Mesa Drivers. Something to add its that the `OpenGL Provider` and `Vulkan ICD` settings have priority over this.
@@ -188,4 +200,4 @@ Documentation used:
188200

189201
## Contributing:
190202

191-
Contributions are welcome. Please ensure any changes maintain compatibility with the supported Python versions and follow the existing code structure.
203+
Contributions are welcome. Please ensure any changes maintain compatibility with the supported Python versions and follow the existing code structure. You might want to read: [Build/Test Requirements](#buildtest-requirements), [Installation](#installation) and [Testing volt-gui](#testing-volt-gui).

0 commit comments

Comments
 (0)