documents new dep to cppcheck

[psensor.git] / README

diff --git a/README b/README
index e1024d0..2c39655 100644 (file)
--- a/README
+++ b/README
@@ -8,7 +8,7 @@ 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 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.
@@ -53,9 +53,17 @@ http://packages.qa.debian.org/p/psensor.html
 
 Compilation requires the following packages:
 
-gettext libgtk-3-dev libgconf2-dev libnotify-dev libsensors4-dev
+asciidoc cppcheck 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:
+asciidoc cppcheck gcc libgtk3.0-dev libsensors4-dev libgconf2-dev
 help2man libcurl4-openssl-dev libjson0-dev libmicrohttpd-dev
-libgtop2-dev
+libgtop2-dev libatasmart-dev
 
 Ubuntu
 ------
@@ -80,50 +88,61 @@ 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:
 
-Centos 6
---------
+ * installs the usual Psensor build dependencies and fglrx ubuntu
+   package.
 
-psensor can be compiled on Centos 6.0, by installing the following
-packages:
-gcc gtk2-devel GConf2-devel help2man gettext-devel libnotify-deval
-lm_sensors-devel libgtop2-devel
+ * 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].
 
-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.
+ * 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
 --------------------------------
 
 Psensor compilation requires:
-
  * make/gcc    
  * lm-sensors
  * library sensors4
- * library gtk2 (>= 2.18)
+ * library gtk3
  * library gconf2
  * help2man 
+ * asciidoc (optional, required to produce the html version of the
+   faq)
+ * cppcheck (optional, static source checker)
  * library libnotify (optional)
  * library libappindicator (optional)
  * library libXNVCtrl (optional)
  * 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    
  * lm-sensors
  * library sensors4
  * help2man 
  * library libmicrohttpd 
  * library json0
+ * asciidoc (optional, required to produce the html version of the
+   faq)
+ * cppcheck (optional, static source checker)
  * library gtop2 (optional, required for CPU usage)
+ * library atasmart (optional, for disk monitoring)
 
 Compilation and Installation Steps
 ----------------------------------
@@ -143,6 +162,19 @@ Compilation and Installation Steps
 
  * Run 'psensor'
 
+Compilation on Fedora 17
+------------------------
+
+ * install mandatory packages:
+   sudo yum install gcc gtk3-devel GConf2-devel lm_sensors-devel
+
+ * install additional recommended packages:
+   sudo yum install libatasmart-devel libcurl-devel json-c-devel
+                    libmicrohttpd-devel help2man libnotify-devel
+                    libgtop2-devel
+
+ * follow instructions from 'Compilation and Installation Steps'
+
 Contact
 -------
 Bugs and comments can be sent to jeanfi@gmail.com