mirror of
https://gitlab.com/ryzen-controller-team/ryzen-controller.git
synced 2024-12-22 10:03:28 +07:00
Bump version, updated readme.
This commit is contained in:
parent
db745b344d
commit
00c6a28c8c
1
.gitignore
vendored
1
.gitignore
vendored
@ -1 +1,2 @@
|
||||
node_modules
|
||||
bin/*
|
60
README.md
60
README.md
@ -1,45 +1,39 @@
|
||||
# electron-quick-start
|
||||
# Ryzen controller
|
||||
|
||||
**Clone and run for a quick way to see Electron in action.**
|
||||
## For users
|
||||
|
||||
This is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start) within the Electron documentation.
|
||||
### Pre-requisite
|
||||
|
||||
**Use this app along with the [Electron API Demos](https://electronjs.org/#get-started) app for API code examples to help you get started.**
|
||||
- Go to https://github.com/FlyGoat/RyzenAdj/releases
|
||||
- Download the latest compiled version.
|
||||
- Put the content into the bin folder where the "RyzenController.exe" is.
|
||||
- So you have
|
||||
```
|
||||
RyzenFolder/
|
||||
| RyzenController.exe
|
||||
| | bin/
|
||||
| | | ryzenadj.exe
|
||||
| | | WinRing0x64.dll
|
||||
| | | WinRing0x64.sys
|
||||
```
|
||||
|
||||
A basic Electron application needs just these files:
|
||||
## For developpers
|
||||
|
||||
- `package.json` - Points to the app's main file and lists its details and dependencies.
|
||||
- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.
|
||||
- `index.html` - A web page to render. This is the app's **renderer process**.
|
||||
### Pre-requisite
|
||||
|
||||
You can learn more about each of these components within the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start).
|
||||
- NodeJS v10.15.1 or newer.
|
||||
|
||||
## To Use
|
||||
|
||||
To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
# Clone this repository
|
||||
git clone https://github.com/electron/electron-quick-start
|
||||
# Go into the repository
|
||||
cd electron-quick-start
|
||||
# Install dependencies
|
||||
npm install
|
||||
# Run the app
|
||||
npm start
|
||||
$> cd project
|
||||
$> npm install
|
||||
$> npm start
|
||||
```
|
||||
|
||||
Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.
|
||||
### Build
|
||||
|
||||
## Resources for Learning Electron
|
||||
|
||||
- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation
|
||||
- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community
|
||||
- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app
|
||||
- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further
|
||||
- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron
|
||||
- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs
|
||||
|
||||
## License
|
||||
|
||||
[CC0 1.0 (Public Domain)](LICENSE.md)
|
||||
```bash
|
||||
$> cd project
|
||||
$> npm run-script build
|
||||
```
|
||||
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "ryzen-controller",
|
||||
"productName": "Ryzen Controller",
|
||||
"version": "0.1.0",
|
||||
"version": "1.0.0",
|
||||
"description": "A minimal Electron application to use ryzenAdj through a friendly interface.",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
|
Loading…
Reference in New Issue
Block a user