Skip to content

Commit

Permalink
Merge pull request #29 from portellam/master
Browse files Browse the repository at this point in the history
Master
  • Loading branch information
portellam authored Jul 11, 2024
2 parents 7800f9f + 68e0c05 commit 4b31851
Show file tree
Hide file tree
Showing 6 changed files with 1,690 additions and 505 deletions.
49 changes: 44 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Power State Virtual Machine Manager
### v0.1.1-dev
### v1.0.0-alpha
Set the power state of a QEMU/KVM Virtual Machine (VM). Wake from Sleep or
Hibernation. Does what `virt-manager` doesn't.

## Status: Pre-Development
**[Latest release](https://github.com/portellam/powerstate-virtmanager/releases/latest)**

## Table of Contents
- [1. Why?](#1-why)
Expand All @@ -15,6 +15,8 @@ Hibernation. Does what `virt-manager` doesn't.
- [4.3. Hardware](#43-hardware)
- [5. Download](#5-download)
- [6. Usage](#6-usage)
- [6.1. Install](#61-install)
- [6.2. Run](#62-run)
- [7. Contact](#7-contact)
- [8. References](#8-references)

Expand Down Expand Up @@ -61,18 +63,55 @@ ability to wake from Sleep and Hibernation, and the other related features from
Linux.

#### 4.2. Software
**Note:** This information is pending development and is subject to change.
- `QEMU` and `Libvirt` for Virtual Machines.

#### 4.3. Hardware
The following firmware options are supported and enabled (motherboard and CPU):
- System Power State S3 (Sleep).
- System Power State S4 (Hibernation).

### 5. Download
**Note:** This information is pending development and is subject to change.
- Download the Latest Release: [Codeberg][codeberg-releases],
[GitHub][github-releases]

- Download the `.zip` file:
1. Viewing from the top of the repository's (current) webpage, click the
drop-down icon:
- `···` on Codeberg.
- `<> Code ` on GitHub.
2. Click `Download ZIP` and save.
3. Open the `.zip` file, then extract its contents.

- Clone the repository:
1. Open a Command Line Interface (CLI).
- Open a console emulator (for Debian systems: Konsole).
- Open a existing console: press `CTRL` + `ALT` + `F2`, `F3`, `F4`, `F5`, or
`F6`.
- **To return to the desktop,** press `CTRL` + `ALT` + `F7`.
- `F1` is reserved for debug output of the Linux kernel.
- `F7` is reserved for video output of the desktop environment.
- `F8` and above are unused.
2. Change your directory to your home folder or anywhere safe:
- `cd ~`
3. Clone the repository:
- `git clone https://www.codeberg.org/portellam/powerstate-virtmanager`
- `git clone https://www.github.com/portellam/powerstate-virtmanager`

[codeberg-releases]: https://codeberg.org/portellam/powerstate-virtmanager/releases/latest
[github-releases]: https://github.com/portellam/powerstate-virtmanager/releases/latest

### 6. Usage
**Note:** This information is pending development and is subject to change.
#### 6.1. Install
```bash
sudo bash installer.sh
```

#### 6.2. Run
Installer will copy required files to `/usr/bin/local/`. You may run executable
from any directory.
```bash
sudo powerstate-virtmanager
```

### 7. Contact
Did you encounter a bug? Do you need help? Please visit the
Expand Down
Loading

0 comments on commit 4b31851

Please sign in to comment.