Skip to content

Commit 0bf15a6

Browse files
committed
Updated README.
1 parent 68e0c05 commit 0bf15a6

File tree

2 files changed

+35
-48
lines changed

2 files changed

+35
-48
lines changed

README.md

Lines changed: 34 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Power State Virtual Machine Manager
2-
### v1.0.0-alpha
2+
### v1.0.0
33
Set the power state of a QEMU/KVM Virtual Machine (VM). Wake from Sleep or
44
Hibernation. Does what `virt-manager` doesn't.
55

6-
**[Latest release](https://github.com/portellam/powerstate-virtmanager/releases/latest)**
6+
## [Download](#5-download)
7+
#### View this repository on [Codeberg][01], [GitHub][02].
8+
[01]: https://codeberg.org/portellam/powerstate-virtmanager
9+
[02]: https://github.com/portellam/powerstate-virtmanager
10+
##
711

812
## Table of Contents
913
- [1. Why?](#1-why)
@@ -30,33 +34,17 @@ ability to wake from Sleep and Hibernation, and the other related features from
3034
`virt-manager`.
3135

3236
### 2. Related Projects
33-
| Project | Codeberg | GitHub |
34-
| :--- | :---: | :---: |
35-
| Deploy VFIO | [link][codeberg1] | [link][github1] |
36-
| Auto X.Org | [link][codeberg2] | [link][github2] |
37-
| Generate Evdev | [link][codeberg3] | [link][github3] |
38-
| Guest Machine Guide | [link][codeberg4] | [link][github4] |
39-
| Libvirt Hooks | [link][codeberg5] | [link][github5] |
40-
| **Power State Virtual Machine Manager** | [link][codeberg6] | [link][github6] |
41-
42-
[codeberg1]: https://codeberg.org/portellam/deploy-VFIO
43-
[github1]: https://github.com/portellam/deploy-VFIO
44-
[codeberg2]: https://codeberg.org/portellam/auto-xorg
45-
[github2]: https://github.com/portellam/auto-xorg
46-
[codeberg3]: https://codeberg.org/portellam/generate-evdev
47-
[github3]: https://github.com/portellam/generate-evdev
48-
[codeberg4]: https://codeberg.org/portellam/guest-machine-guide
49-
[github4]: https://github.com/portellam/guest-machine-guide
50-
[codeberg5]: https://codeberg.org/portellam/libvirt-hooks
51-
[github5]: https://github.com/portellam/libvirt-hooks
52-
[codeberg6]: https://codeberg.org/portellam/powerstate-virtmanager
53-
[github6]: https://github.com/portellam/powerstate-virtmanager
37+
To view other relevant projects, visit [Codeberg][21]
38+
or [GitHub][22].
39+
40+
[21]: https://codeberg.org/portellam/vfio-collection
41+
[22]: https://github.com/portellam/vfio-collection
5442

5543
### 3. Documentation
56-
- [What is VFIO?](#2)
57-
- [VFIO Discussion and Support](#3)
58-
- [Hardware-Passthrough Guide](#1)
59-
- [Virtual Machine XML Format Guide](#4)
44+
- What is VFIO?[<sup>[2]</sup>](#2)
45+
- VFIO Discussion and Support[<sup>[3]</sup>](#3)
46+
- Hardware-Passthrough Guide[<sup>[1]</sup>](#1)
47+
- Virtual Machine XML Format Guide[<sup>[4]</sup>](#4)
6048

6149
### 4. Host Requirements
6250
#### 4.1. Operating System
@@ -71,8 +59,7 @@ The following firmware options are supported and enabled (motherboard and CPU):
7159
- System Power State S4 (Hibernation).
7260

7361
### 5. Download
74-
- Download the Latest Release:&ensp;[Codeberg][codeberg-releases],
75-
[GitHub][github-releases]
62+
- Download the Latest Release:&ensp;[Codeberg][51], [GitHub][52]
7663

7764
- Download the `.zip` file:
7865
1. Viewing from the top of the repository's (current) webpage, click the
@@ -83,10 +70,10 @@ The following firmware options are supported and enabled (motherboard and CPU):
8370
3. Open the `.zip` file, then extract its contents.
8471

8572
- Clone the repository:
86-
1. Open a Command Line Interface (CLI).
73+
1. Open a Command Line Interface (CLI) or Terminal.
8774
- Open a console emulator (for Debian systems: Konsole).
88-
- Open a existing console: press `CTRL` + `ALT` + `F2`, `F3`, `F4`, `F5`, or
89-
`F6`.
75+
- **Linux only:** Open an existing console: press `CTRL` + `ALT` + `F2`,
76+
`F3`, `F4`, `F5`, or `F6`.
9077
- **To return to the desktop,** press `CTRL` + `ALT` + `F7`.
9178
- `F1` is reserved for debug output of the Linux kernel.
9279
- `F7` is reserved for video output of the desktop environment.
@@ -97,8 +84,8 @@ The following firmware options are supported and enabled (motherboard and CPU):
9784
- `git clone https://www.codeberg.org/portellam/powerstate-virtmanager`
9885
- `git clone https://www.github.com/portellam/powerstate-virtmanager`
9986

100-
[codeberg-releases]: https://codeberg.org/portellam/powerstate-virtmanager/releases/latest
101-
[github-releases]: https://github.com/portellam/powerstate-virtmanager/releases/latest
87+
[51]: https://codeberg.org/portellam/powerstate-virtmanager/releases/latest
88+
[52]: https://github.com/portellam/powerstate-virtmanager/releases/latest
10289

10390
### 6. Usage
10491
#### 6.1. Install
@@ -114,26 +101,26 @@ sudo powerstate-virtmanager
114101
```
115102

116103
### 7. Contact
117-
Did you encounter a bug? Do you need help? Please visit the
118-
**Issues page** ([Codeberg][codeberg-issues], [GitHub][github-issues]).
104+
Do you need help? Please visit the [Issues][71] page.
119105

120-
[codeberg-issues]: https://codeberg.org/portellam/powerstate-virtmanager/issues
121-
[github-issues]: https://github.com/portellam/powerstate-virtmanager/issues
106+
[71]: https://github.com/portellam/powerstate-virtmanager/issues
122107

123108
### 8. References
124109
#### 1.
125-
**PCI passthrough via OVMF**. ArchWiki. Accessed June 14, 2024.
126-
<sup>https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF.</sup>
110+
&nbsp;&nbsp;**PCI passthrough via OVMF**. ArchWiki. Accessed June 14, 2024.
111+
112+
&nbsp;&nbsp;&nbsp;&nbsp;<sup>https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF.</sup>
127113

128114
#### 2.
129-
**VFIO - ‘Virtual Function I/O’ - The Linux Kernel Documentation**.
115+
&nbsp;&nbsp;**VFIO - ‘Virtual Function I/O’ - The Linux Kernel Documentation**.
130116
The linux kernel. Accessed June 14, 2024.
131-
<sup>https://www.kernel.org/doc/html/latest/driver-api/vfio.html.</sup>
117+
118+
&nbsp;&nbsp;&nbsp;&nbsp;<sup>https://www.kernel.org/doc/html/latest/driver-api/vfio.html.</sup>
132119

133120
#### 3.
134-
**VFIO Discussion and Support**. Reddit. Accessed June 14, 2024.
135-
<sup>https://www.reddit.com/r/VFIO/.</sup>
121+
&nbsp;&nbsp;**VFIO Discussion and Support**. Reddit. Accessed June 14, 2024.
122+
123+
&nbsp;&nbsp;&nbsp;&nbsp;<sup>https://www.reddit.com/r/VFIO/.</sup>
124+
##
136125

137-
#### 4.
138-
**XML Design Format** GitHub - libvirt/libvirt. Accessed June 18, 2024.
139-
<sup>https://github.com/libvirt/libvirt/blob/master/docs/formatdomain.rst.</sup>
126+
#### Click [here](#auto-xorg) to return to the top of this document.

bin/powerstate-virtmanager.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
#
44
# Filename: powerstate-virtmanager.sh
5-
# Version: 1.0.0-alpha
5+
# Version: 1.0.0
66
# Description: Set the power state of a QEMU/KVM Virtual Machine (VM).
77
# Author(s): Alex Portell <github.com/portellam>
88
# Maintainer(s): Alex Portell <github.com/portellam>

0 commit comments

Comments
 (0)