added basic instruction in the README for compiling psensor with the ATI/AMD GPU...

[psensor.git] / README

diff --git a/README b/README
index d137cb6..cc25948 100644 (file)
--- a/README
+++ b/README
@@ -5,13 +5,13 @@ Psensor is a graphical temperature monitor for Linux.
 
 It can monitor:
 
-  * the temperature of the motherboard and CPU sensors (using
-    lm-sensors).
-  * the temperature of the NVidia GPUs (using XNVCtrl).
-  * the temperature of the Hard Disk Drives (using hddtemp).
-  * the rotation speed of the fans (using lm-sensors).
-  * the temperature of a remote computer.
-  * the cpu load.
+ * the temperature of the motherboard and CPU sensors (using
+   lm-sensors).
+ * the temperature of the NVidia GPUs (using XNVCtrl).
+ * the temperature of the Hard Disk Drives (using hddtemp).
+ * the rotation speed of the fans (using lm-sensors).
+ * the temperature of a remote computer.
+ * the cpu load.
 
 Alarms using Desktop Notification can be set to each sensor to notify
 high temperatures.
@@ -21,12 +21,12 @@ alert users when a temperature is too high.
 
 To monitor the temperature of a remote computer:
 
-  * start psensor-server on the remote computer. The default port is
-    3131 and can be changed by using the '--port=PORT' command line
-    option.
+ * start psensor-server on the remote computer. The default port is
+   3131 and can be changed by using the '--port=PORT' command line
+   option.
 
-  * start psensor with the '--url' option: 
-  psensor --url=http://hostname:3131
+ * start psensor with the '--url' option: psensor
+  --url=http://hostname:3131
 
 WARNING: 
 psensor-server does not provide any way to restrict the connection to
@@ -39,6 +39,9 @@ tools of the system (for example, iptables).
 Installation
 ------------
 
+Psensor can be compiled and installed on any modern linux
+distribution.
+
 Debian
 ------
 
@@ -54,6 +57,13 @@ gettext libgtk-3-dev libgconf2-dev libnotify-dev libsensors4-dev
 help2man libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev
 libgtop2-dev
 
+Debian kfreebsd
+---------------
+
+Compilation requires the following packages:
+gcc libgtk2.0-dev libsensors4-dev libgconf2-dev help2man
+libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev libgtop2-dev
+
 Ubuntu
 ------
 
@@ -95,6 +105,27 @@ As microhttpd and json-c libraries are not available in the standard centos
 repository, psensor-server cannot be compiled and the remote
 monitoring feature of psensor will not be available.
 
+ATI/AMD GPU Support
+-------------------
+
+To compile Psensor with ATI support on Ubuntu:
+
+ * installs the usual Psensor build dependencies and fglrx ubuntu
+   package.
+
+ * downloads the ATI ADL SDK from:
+   http://developer.amd.com/sdks/ADLSDK/Pages/default.aspx and
+   extracts the files of the archive into a directory [dir].
+
+ * configure the build environment: 
+   ./configure --with-libatiadl=[dir]   
+   where [dir] must be the directory where you have extracted the ATI
+   ADL SDK.
+
+ * then follow usual GNU autotools compilation:
+   make clean all
+   make install
+
 Installation from source archive
 --------------------------------
 
@@ -134,7 +165,7 @@ Compilation and Installation Steps
    make install
 
  * Start the sensor detection script: 'sensors-detect' and follows the
-instructions
+   instructions
 
  * Verify the sensor detection by running: 'sensors'