projects / psensor.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
documents new dep to cppcheck
[psensor.git] / README
diff --git a/README b/README
index 362016e..2c39655 100644 (file)
--- a/README
+++ b/README
@@ -5,12 +5,13 @@ Psensor is a graphical temperature monitor for Linux.
 
 It can monitor:
 
 
 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.
 
 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:
 
 
 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
 
 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
 ------------
 
 Installation
 ------------
 
+Psensor can be compiled and installed on any modern linux
+distribution.
+
 Debian
 ------
 
 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
 
 Debian package information are available at:
 http://packages.qa.debian.org/p/psensor.html
 
+Compilation requires the following packages:
+
+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 libatasmart-dev
+
 Ubuntu
 ------
 
 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
 
 For the last stable version:
 sudo apt-get apt-add-repository ppa:/jfi/psensor
@@ -64,39 +88,61 @@ sudo apt-get update
 sudo apt-get install psensor
 sudo apt-get install psensor-server
 
 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
 --------------------------------
 
 Psensor compilation requires:
 
 Installation from source archive
 --------------------------------
 
 Psensor compilation requires:
-
  * make/gcc    
  * lm-sensors
  * library sensors4
  * make/gcc    
  * lm-sensors
  * library sensors4
- * library gtk2
+ * library gtk3
  * library gconf2
  * help2man 
  * 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 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:
 
 Psensor-server compilation requires:
+
  * make/gcc    
  * lm-sensors
  * library sensors4
  * help2man 
  * library libmicrohttpd 
  * library json0
  * make/gcc    
  * lm-sensors
  * library sensors4
  * help2man 
  * library libmicrohttpd 
  * library json0
- * library LUA5.1 (optional, required to enable HTML page generation   
- of the psensor-server webserver)
+ * asciidoc (optional, required to produce the html version of the
+   faq)
+ * cppcheck (optional, static source checker)
  * library gtop2 (optional, required for CPU usage)
  * library gtop2 (optional, required for CPU usage)
+ * library atasmart (optional, for disk monitoring)
 
 Compilation and Installation Steps
 ----------------------------------
 
 Compilation and Installation Steps
 ----------------------------------
@@ -110,12 +156,25 @@ Compilation and Installation Steps
    make install
 
  * Start the sensor detection script: 'sensors-detect' and follows the
    make install
 
  * Start the sensor detection script: 'sensors-detect' and follows the
-instructions
+   instructions
 
  * Verify the sensor detection by running: 'sensors'
 
  * Run 'psensor'
 
 
  * Verify the sensor detection by running: 'sensors'
 
  * 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
 Contact
 -------
 Bugs and comments can be sent to jeanfi@gmail.com
psensor