Skip to content

Commit c714c1f

Browse files
committed
add README
1 parent 09c1689 commit c714c1f

3 files changed

Lines changed: 98 additions & 0 deletions

File tree

.github/FUNDING.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # SergiyE # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/master.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: master
2+
3+
on:
4+
push:
5+
branches: [master]
6+
7+
jobs:
8+
build:
9+
runs-on: windows-2022
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: nuget/setup-nuget@v2
13+
- uses: microsoft/setup-msbuild@v1.1
14+
with:
15+
msbuild-architecture: x64
16+
17+
- uses: dorny/paths-filter@v2
18+
id: changes
19+
with:
20+
filters: |
21+
buildprops:
22+
- 'Directory.Build.props'
23+
24+
- name: NuGet restore
25+
run: nuget restore OpenHardwareMonitor.sln
26+
27+
- name: Build
28+
run: msbuild OpenHardwareMonitor.sln -p:Configuration=Release -m
29+
30+
- name: Publish build
31+
uses: actions/upload-artifact@v4
32+
with:
33+
name: OpenHardwareMonitor
34+
path: |
35+
bin/OpenHardwareMonitor

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Open hardware monitor
2+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/sergiye/openhardwaremonitor?style=plastic)
3+
![GitHub all releases](https://img.shields.io/github/downloads/sergiye/openhardwaremonitor/total?style=plastic)
4+
![GitHub last commit](https://img.shields.io/github/last-commit/sergiye/openhardwaremonitor?style=plastic)
5+
6+
Open hardware monitor - is free software that can monitor the temperature sensors, fan speeds, voltages, load and clock speeds of your computer.
7+
8+
This application is based on the "original" [openhardwaremonitor](https://github.com/openhardwaremonitor/openhardwaremonitor) project.
9+
10+
## Features
11+
12+
### What can it do?
13+
14+
You can see information about devices such as:
15+
- Motherboards
16+
- Intel and AMD processors
17+
- RAM
18+
- NVIDIA and AMD graphics cards
19+
- HDD, SSD and NVMe hard drives
20+
- Network cards
21+
- Power suppliers
22+
- Laptop batteries
23+
24+
Supports `Portable` mode for storing temporary driver file and settings configuration next to the executable file.
25+
Supports `Light`/`Dark` themes with auto switching mode.
26+
Supports (manual only) checking for updated versions.
27+
28+
Some sensors are only available when running the application as administrator.
29+
30+
# Download
31+
32+
**The recommended way to get the program is BUILD from source**
33+
- Install git, Visual Studio
34+
- `git clone https://github.com/sergiye/openhardwaremonitor.git`
35+
- build
36+
37+
**or download build from [releases](https://github.com/sergiye/openhardwaremonitor/releases).**
38+
39+
### Auto builds
40+
If you have a **GitHub** account, you can download nightly builds [here](https://github.com/sergiye/openhardwaremonitor/actions).
41+
42+
## How can I help improve it?
43+
The OpenHardwareMonitor team welcomes feedback and contributions!<br/>
44+
You can check if it works properly on your motherboard. For many manufacturers, the way of reading data differs a bit, so if you notice any inaccuracies, please send us a pull request. If you have any suggestions or improvements, don't hesitate to create an issue.
45+
46+
## License
47+
48+
OpenHardwareMonitor is free and open source software licensed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). You can use it for personal and commercial purposes.
49+
50+
Copyright © 2022 Sergiy Egoshyn

0 commit comments

Comments
 (0)