Bladeren bron

Usage instructions and build status

Tankernn 8 jaren geleden
bovenliggende
commit
da37572783
1 gewijzigde bestanden met toevoegingen van 12 en 1 verwijderingen
  1. 12 1
      README.md

+ 12 - 1
README.md

@@ -1,6 +1,15 @@
 # JavaGridControl
+[![Build Status](https://tankernn.eu/jenkins/buildStatus/icon?job=JavaGridControl)](https://tankernn.eu/jenkins/job/JavaGridControl)
 A Java-based, open-source alternative to the default control software for the NZXT GRID+ and GRID+v2.
 
+## Usage
+1. If you are running Windows, download and install [OpenHardwareMonitor](http://openhardwaremonitor.org/).
+2. Download the latest version of JavaGridControl from [Jenkins](https://tankernn.eu/jenkins/job/JavaGridControl).
+3. Run the jar-file. (append 'nogui' to command line for headless mode)
+  * Currently, configuration is only possible through the GUI, though your settings will persist even if you run in headless mode after configuring.
+4. Select appropriate COM-port using the combo box at the top.
+5. When the window is closed, the program will keep running in the background. Use the system tray icon to exit completely.
+
 ## Credit
 - This project was originally a fork of [RoelGo/CamSucks](https://github.com/RoelGo/CamSucks)
 - The reverse engineering of the GRID+ communication was done by rizvanrp, their site is no longer available but here is a screenshot of their article on the GRID+. http://research.domaintools.com/research/screenshot-history/rizvanrp.com/#0
@@ -12,4 +21,6 @@ A Java-based, open-source alternative to the default control software for the NZ
 - Make it possible to set weights for different temperature readings.
 - Linux support.
 - Unit tests
-- Documentation
+- GUI Improvements
+  - More menu items (exit, etc.)
+  - Profile Editor labels