mirror of
https://gitlab.com/ryzen-controller-team/ryzen-controller.git
synced 2024-12-22 10:03:28 +07:00
Updated readme for non-windows users.
This commit is contained in:
parent
6b967b1720
commit
0e27eb0e85
91
README.md
91
README.md
@ -1,21 +1,61 @@
|
|||||||
# Ryzen controller
|
# Ryzen controller
|
||||||
|
|
||||||
Thanks to https://github.com/FlyGoat/RyzenAdj and his author, ryzenadj.exe is now included.
|
- [Installation](#installation)
|
||||||
No more need for multiple download =D
|
- [Windows](#windows)
|
||||||
|
- [Debian like](#debian-like)
|
||||||
|
- [Redhat like](#redhat-like)
|
||||||
|
- [Development](#development)
|
||||||
|
- [Pre-requisite](#pre-requisite)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Building binaries](#building-binaries)
|
||||||
|
- [Using Windows](#using-windows)
|
||||||
|
- [Using Linux](#using-linux)
|
||||||
|
- [Building installers](#building-installers)
|
||||||
|
- [For Windows](#for-windows)
|
||||||
|
- [For Debian like](#for-debian-like)
|
||||||
|
- [For Redhat like](#for-redhat-like)
|
||||||
|
|
||||||
## For users
|
Thanks to https://github.com/FlyGoat/RyzenAdj and his author, ryzenadj.exe is included (windows only for now).
|
||||||
|
|
||||||
### Pre-requisite
|
## Installation
|
||||||
|
|
||||||
|
### Windows
|
||||||
|
|
||||||
- Go to [release page](https://gitlab.com/le.storm1er/ryzen-controller/releases)
|
- Go to [release page](https://gitlab.com/le.storm1er/ryzen-controller/releases)
|
||||||
- Download the latest RyzenControllerInstaller.exe
|
- Download the latest `RyzenControllerInstaller.exe`
|
||||||
- Enjoy!
|
- Enjoy!
|
||||||
|
|
||||||
## For developpers
|
### Debian like
|
||||||
|
|
||||||
|
- Go to [RyzenAdj](https://github.com/FlyGoat/RyzenAdj) repo.
|
||||||
|
- Download and build as explained in [Build requirements](https://github.com/FlyGoat/RyzenAdj#build-requirements).
|
||||||
|
- Go to Ryzen Controller's [release page](https://gitlab.com/le.storm1er/ryzen-controller/releases)
|
||||||
|
- Download the latest `ryzencontroller_VERSION_ARCH.deb` file.
|
||||||
|
- `sudo dpkg -i ryzencontroller_VERSION_ARCH.deb`
|
||||||
|
- Launch with `sudo ryzencontroller`
|
||||||
|
- Set the path to your freshly builded `ryzenadj` binary into the "settings" tab.
|
||||||
|
- Enjoy!
|
||||||
|
|
||||||
|
### Redhat like
|
||||||
|
|
||||||
|
- Go to [RyzenAdj](https://github.com/FlyGoat/RyzenAdj) repo.
|
||||||
|
- Download and build as explained in [Build requirements](https://github.com/FlyGoat/RyzenAdj#build-requirements).
|
||||||
|
- Go to Ryzen Controller's [release page](https://gitlab.com/le.storm1er/ryzen-controller/releases)
|
||||||
|
- Download the latest `ryzencontroller_VERSION_ARCH.rpm` file.
|
||||||
|
- `sudo rpm -u ryzencontroller_VERSION_ARCH.rpm`
|
||||||
|
- Launch with `sudo ryzencontroller`
|
||||||
|
- Set the path to your freshly builded `ryzenadj` binary into the "settings" tab.
|
||||||
|
- Enjoy!
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
### Pre-requisite
|
### Pre-requisite
|
||||||
|
|
||||||
- NodeJS v10.15.1 or newer.
|
- NodeJS v10.15.1 or newer.
|
||||||
|
- About building dependencies:
|
||||||
|
- No dependencies for windows installer
|
||||||
|
- See [electron-installer-debian requirements](https://github.com/electron-userland/electron-installer-debian#requirements)
|
||||||
|
- See [electron-installer-redhat requirements](https://github.com/electron-userland/electron-installer-redhat#requirements)
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
@ -25,9 +65,44 @@ $> npm install
|
|||||||
$> npm start
|
$> npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
### Build
|
### Building binaries
|
||||||
|
|
||||||
|
#### Using Windows
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$> cd project
|
$> cd project
|
||||||
$> npm run-script build
|
$> npm run-script package-win32
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Using Linux
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$> cd project
|
||||||
|
$> npm run-script package-linux
|
||||||
|
```
|
||||||
|
|
||||||
|
### Building installers
|
||||||
|
|
||||||
|
#### For Windows
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$> cd project
|
||||||
|
$> npm run-script package-win32
|
||||||
|
$> npm run-script build-win32
|
||||||
|
```
|
||||||
|
|
||||||
|
#### For Debian like
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$> cd project
|
||||||
|
$> npm run-script package-linux
|
||||||
|
$> npm run-script build-deb
|
||||||
|
```
|
||||||
|
|
||||||
|
#### For Redhat like
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$> cd project
|
||||||
|
$> npm run-script package-linux
|
||||||
|
$> npm run-script build-rpm
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user