improved

[www.git] / src / psensor / index.adoc

diff --git a/src/psensor/index.adoc b/src/psensor/index.adoc
index 3df983e..e5fcf86 100644 (file)
--- a/src/psensor/index.adoc
+++ b/src/psensor/index.adoc
@@ -1 +1,102 @@
-= psensor - A Graphical Temperature Monitoring Application
+= psensor
+
+== A Graphical Temperature Monitoring Application
+
+Psensor is a graphical hardware temperature monitor for Linux.
+
+It can monitor:
+
+- the temperature of the motherboard and CPU sensors (using http://www.lm-sensors.org/[lm-sensors]).
+- the temperature of the NVidia GPUs (using XNVCtrl).
+- the temperature of ATI/AMD GPUs (not enabled in Ubuntu PPAs or official
+  distribution repositories, see the http://wpitchoune.net/psensor/doc/README.html#_ati_amd_gpu_support[instructions for enabling its support]).
+- the temperature of the Hard Disk Drives (using hddtemp or libatasmart).
+- the rotation speed of the fans (using lm-sensors).
+- the CPU usage (since 0.6.2.10 and using Gtop2).
+
+image::http://wpitchoune.net/psensor/screenshots/psensor-last.png[]
+image::http://wpitchoune.net/psensor/screenshots/psensor-2011-06-16.png[]
+
+The application is designed to be simple and easy to use. The CPU and memory consumption are not significant.
+
+Psensor is released under GPLv2 license terms.
+
+== Usage Information
+
+First step is to install `lm-sensors`.
+
+For Ubuntu:
+
+[source,script]
+----
+sudo apt-get install lm-sensors
+----
+
+Then, starts the detection of your hardware sensors:
+
+[source,script]
+----
+sudo sensors-detect
+----
+
+Verify that it works:
+
+[source,script]
+----
+sensors
+----
+
+It should display something like:
+
+----
+coretemp-isa-0000
+Adapter: ISA adapter
+Core 0:      +46.0C  (high = +76.0C, crit = +100.0C)
+
+coretemp-isa-0001
+Adapter: ISA adapter
+Core 1:      +44.0C  (high = +76.0C, crit = +100.0C)
+
+...
+----
+
+Then you can proceed to the installation of `psensor`. For Ubuntu and derivatives,
+ you should look at the link:psensor_ubuntu.html[Ubuntu support page].
+
+And finally launch the `psensor` executable.
+
+More information are available in the Psensor FAQ.
+
+== Source Code
+
+* link:files[Download psensor]
+* Get source from the GIT repository:
+----
+git clone http://git.wpitchoune.net/psensor.git
+----
+* link:http://git.wpitchoune.net/gitweb?p=psensor.git[Browse source code]
+
+== Linux Distribution Support
+
+`psensor` should compile on any modern distribution including `GTK+`` v3 and
+`lm-sensors` which are quite common. For Linux Distribution still stuck on
+ `GTK+`` v2, the old 0.6.x releases of `psensor` can be used.
+
+If you have trouble compiling `psensor` on a specific Linux distribution,
+don’t hesitate to report it.
+
+Binary packages of `psensor` are available for few Linux distributions:
+
+* Psensor is in the official universe repository of Ubuntu since version 11.10 (Oneiric)
+* Psensor packages for Debian, Psensor is in the standard repository of Debian since 7.0.
+* link:https://launchpad.net/~jfi/+archive/ubuntu/ppa[PPA for Ubuntu]
+* link:http://software.opensuse.org/package/psensor[package for OpenSuse]
+* link:https://aur.archlinux.org/packages/psensor/[Package for ArchLinux]
+
+== Contact
+
+The Google Group psensor-users can be used for discussion, questions and bug report.
+
+For announces or general information subscribe to Psensor Google+ page.
+
+Alternatively, you can contact me by e-mail: jeanfi@gmail.com.