gtk3 minimal version

[psensor.git] / README

diff --git a/README b/README
index 988e7f3..3f69daf 100644 (file)
--- a/README
+++ b/README
@@ -5,12 +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 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 or libatasmart).
+ * 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.
@@ -20,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
@@ -38,6 +39,9 @@ tools of the system (for example, iptables).
 Installation
 ------------
 
+Psensor can be compiled and installed on any modern linux
+distribution.
+
 Debian
 ------
 
@@ -47,11 +51,31 @@ For Debian, the binary and source packages are available in the wheezy
 Debian package information are available at:
 http://packages.qa.debian.org/p/psensor.html
 
+Compilation requires the following packages:
+
+gettext libgtk-3-dev libgconf2-dev libnotify-dev libsensors4-dev
+help2man libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev
+libgtop2-dev libatasmart-dev
+
+Debian kfreebsd
+---------------
+
+Compilation requires the following packages:
+gcc libgtk3.0-dev libsensors4-dev libgconf2-dev help2man
+libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev libgtop2-dev
+libatasmart-dev
+
 Ubuntu
 ------
 
-For Ubuntu, the easy way to install Psensor and Psensor-server is to
-use the dedicated PPA.
+Notes about installation on Ubuntu is available at:
+http://wpitchoune.net/blog/psensor/ubuntu-integration
+
+Since Ubuntu Oneiric (11.10), psensor is available in the universe
+repository of Ubuntu.
+
+For other Ubuntu releases, the easy way to install Psensor and
+Psensor-server is to use the dedicated PPA.
 
 For the last stable version:
 sudo apt-get apt-add-repository ppa:/jfi/psensor
@@ -64,11 +88,26 @@ sudo apt-get update
 sudo apt-get install psensor
 sudo apt-get install psensor-server
 
-Alternatively, you can download Ubuntu binary packages from:
-http://wpitchoune.net/psensor/files/ubuntu/
-The manual installation of the psensor and psensor-server packages
-requires also the installation of psensor-common which contains
-the multiple languages support.
+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
 --------------------------------
@@ -78,7 +117,7 @@ Psensor compilation requires:
  * make/gcc    
  * lm-sensors
  * library sensors4
- * library gtk2 (>= 2.18)
+ * library gtk3
  * library gconf2
  * help2man 
  * library libnotify (optional)
@@ -87,6 +126,7 @@ Psensor compilation requires:
  * library json0 and curl (optional, required for remote monitoring)
  * library unity (>=v3.4.2, optional)
  * library gtop2 (optional, required for CPU usage)
+ * library atasmart (optional, for disk monitoring)
 
 Psensor-server compilation requires:
  * make/gcc    
@@ -96,6 +136,7 @@ Psensor-server compilation requires:
  * library libmicrohttpd 
  * library json0
  * library gtop2 (optional, required for CPU usage)
+ * library atasmart (optional, for disk monitoring)
 
 Compilation and Installation Steps
 ----------------------------------
@@ -109,7 +150,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'