Skip to content

Commit 8be5e59

Browse files
committed
Update README.md
- Simplified some parts, linked to the Wiki for others - Removed donation links
1 parent 3464944 commit 8be5e59

File tree

1 file changed

+35
-69
lines changed

1 file changed

+35
-69
lines changed

README.md

+35-69
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,65 @@
1-
# WinNUT-Client
1+
WinNUT is a WinForms client for connecting to a Network UPS Tools monitoring server.
22

3-
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate?hosted_button_id=FAFJ3ZKMENGCU)
3+
- 📈 Monitor important values of your UPS like voltage and power consumption
4+
- 🌩️ Receive notifications for abnormal power conditions (power outage)
5+
- ❤️ Keep your hardware and data safe with configurable suspend and shutdown triggers
46

5-
## Installation
6-
To use it, please follow the following steps:
7-
1. Get the [last available Releases](https://github.com/nutdotnet/WinNUT-Client/releases)
8-
2. Install WinNUT-Client using the "WinNUT-Setup.msi" file obtained previously
9-
3. If you were using an older version of WinNUT (v1.x), copy your "ups.ini" configuration file to the WinNUT-Client installation directory (by default "C:\Program Files(x86)\WinNUT-Client ") for an automatic import of your parameters during the first launch
10-
4. Start WinNUT V2 and modify the parameters according to your needs
11-
12-
## Specific Configuration
13-
14-
### For Synology NAS
15-
If your NUT server is hosted on a Synology NAS, be sure to provide the following connection information (default):
16-
Login: upsmon
17-
Password: secret
18-
19-
It will probably be necessary to allow the WinNUT-Client IP to communicate with the NUT server.
20-
*See issue 47 for more information, specifically [this commentary](https://github.com/gawindx/WinNUT-Client/issues/47#issuecomment-759180793).*
21-
22-
### For QNAP NAS
23-
If your NUT server is hosted on a QNAP NAS, be sure to provide the following connection information (default):
24-
UPS Name: qnapups
25-
(Login and Password can be empty)
26-
27-
Also check the "Enable network UPS master" box on the Control Panel -> External device page on the QNAP webinterface and add the IP address of the WinNUT-Client to allow the client to connect to the QNAP for UPS information.
7+
<br />
8+
<br />
289

10+
# Future development
11+
WinNUT has gone through a long evolution with several different programming languages and maintainers. The time has come to retire this iteration of WinNUT and begin planning for the next version. See [issue #40](https://github.com/nutdotnet/WinNUT-Client/issues/40) for more information. Join in the discussions at [Coco.Nut](https://github.com/nutdotnet/Coco.Nut), and shape the future of the next iteration of WinNUT.
2912

30-
###
31-
## Contributing
32-
### Translation
33-
WinNUT-Client V2 is natively multilingual, so it is no longer necessary to select your language from the software interface.
34-
Currently, WinNUT-Client supports:
35-
- English
36-
- German
37-
- French
38-
- Simplified Chinese
39-
- Russian
13+
# Installation
14+
1. Get the [latest Release](https://github.com/nutdotnet/WinNUT-Client/releases)
15+
2. Install WinNUT using the downloaded executable
16+
3. If you were using an older version of WinNUT (v1.x), copy your "ups.ini" configuration file to the WinNUT-Client installation directory (by default "C:\Program Files(x86)\WinNUT-Client ") for an automatic import of your parameters during the first launch
17+
4. Start WinNUT and modify the settings according to your needs
4018

41-
#### To add / correct a language
19+
## Synology NAS
20+
If you are connecting to a Synology NAS with a UPS attached, there is some additional configuration that needs to be done.
4221

43-
##### Method 1 (preferred)
44-
1. [Fork](https://github.com/nutdotnet/WinNUT-Client/fork) this repository
45-
2. In the translation directory:
22+
Referring to the [Synology documentation](https://kb.synology.com/en-us/DSM/help/DSM/AdminCenter/system_hardware_ups?version=7), note that you must add your client computer's IP address to the *Permitted DiskStation Devices* window. In addition, WinNUT requires the following settings:
4623

47-
For a new translation:
48-
1. Use the new_translation.csv file to translate the texts
49-
2. Save this file in xx-XX corresponding to the language code
24+
- **Login**: upsmon
25+
- **Password**: secret
26+
- **UPS Name**: ups
5027

51-
For a correction:
52-
1. Edit the wrong language file
53-
2. Make the necessary corrections
5428

55-
3. Save it instead
56-
4. Create a pull request on this repository to take into account the translation.
29+
*See [issue 47](https://github.com/gawindx/WinNUT-Client/issues/47#issuecomment-759180793) for more information.*
5730

58-
##### Method 2
59-
1. Get the file [new_translation.csv](./Translation/new_translation.csv)
60-
2. Perform the necessary translations
61-
3. Save this file in csv format (IMPORTANT)
62-
4. Create a gist via [gist github](https://gist.github.com) and paste the contents of the previously created csv file
63-
5. Open a new issue and tell me:
64-
- the link of the gist
65-
- the language to create / correct
31+
## QNAP NAS
32+
If your NUT server is hosted on a QNAP NAS, be sure to provide the following connection information (default):
6633

67-
Your translation / correction will be added on a new version and will thus be available to the entire community.
34+
- **UPS Name**: qnapups
35+
- (Login and Password can be empty)
6836

69-
## Update WinNUT-Client
37+
Also check the "Enable network UPS master" box on the Control Panel -> External device page on the QNAP webinterface and add the IP address of the WinNUT-Client to allow the client to connect to the QNAP for UPS information.
7038

71-
Since version 1.8.0.0, WinNUT-Client includes a process for checking for updates.
72-
This process can be started automatically on startup or manually on demand (and you can choose whether you want to update from the stable or development version)
39+
# Contributing
40+
- [Translations](https://github.com/nutdotnet/WinNUT-Client/wiki/Translations)
41+
- [Code/Bug fixes](https://github.com/nutdotnet/WinNUT-Client/wiki/Development)
7342

74-
During this update, the new installation file will be automatically downloaded and you can easily update your version of WinNUT-Client.
43+
# Updates
7544

76-
This process is fully integrated and no longer requires a second executable.
45+
WinNUT has built-in update functionality. This process can be started automatically on startup or manually on demand, and you can choose whether you want to update to the stable or development version. During this process, the new files will be automatically downloaded and installed.
7746

7847
## Third Party Components / Acknowledgments
7948

80-
WinNUT-Client uses:
49+
WinNUT uses:
8150
- a modified version of AGauge initially developed by [Code-Artist](https://github.com/Code-Artist/AGauge) and under [MIT license](https://opensource.org/licenses/MIT)
8251
- Class IniReader developed by [Ludvik Jerabek](https://www.codeproject.com/Articles/21896/INI-Reader-Writer-Class-for-C-VB-NET-and-VBScript) and under [The Code Project Open License](http://www.codeproject.com/info/cpol10.aspx)
8352
- Newtonsoft.Json Library is used in this Project [Newtonsoft.json Website](https://www.newtonsoft.com/json) and under [MIT license](https://opensource.org/licenses/MIT)
8453

8554
## License
8655

8756
WinNUT-Client is a NUT windows client for monitoring your ups hooked up to your favorite linux server.
88-
Copyright (C) 2019-2021 Gawindx (Decaux Nicolas)
57+
58+
- Copyright (C) 2019-2021 Gawindx (Decaux Nicolas)
59+
- Copyright (C) 2022+ NUT Dot Net project
8960

9061
This program is free software: you can redistribute it and/or modify it under the terms of the
9162
GNU General Public License as published by the Free Software Foundation, either version 3 of the
9263
License, or any later version.
9364

94-
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY
95-
96-
## Donation
97-
If you want to support this project or reward the work done, you can do so here:
98-
99-
[![paypal](https://www.paypalobjects.com/en_US/FR/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate?hosted_button_id=FAFJ3ZKMENGCU)
65+
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

0 commit comments

Comments
 (0)