thinkfan version 1.0 -- copyleft 2015, Victor Mataré
====================================================

thinkfan is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
thinkfan is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with thinkfan.  If not, see <http://www.gnu.org/licenses/>.

Thinkfan is a simple, lightweight fan control program. Originally designed
specifically for IBM/Lenovo Thinkpads, it now supports any kind of system via
the sysfs hwmon interface (/sys/class/hwmon). It is designed to eat as little
CPU power as possible.



WARNING!!!!
===========

There's only very basic sanity checking on the configuration (semantic
plausibility). You can set the temperature limits as insane as you like.

Any change to fan behaviour that results in higher temperatures in some parts
of the system will shorten your system's lifetime and/or cause weird hardware
bugs that'll make you pull out your hair.

   No warranties whatsoever.

If this program steals your car, kills your horse, smokes your dope or pees
on your carpet...
 - too bad, you're on your own.




Building and installing
=======================

In the main directory, do
 
 mkdir build && cd build

You can use ccmake to choose build options interactively:

 ccmake ..

Or set your build options from the command line. E.g. to configure a debug
build with support for libatasmart:

 cmake -D USE_ATASMART:BOOL=ON -D CMAKE_BUILD_TYPE:STRING=Debug .

Use CMAKE_BUILD_TYPE:STRING="Release" to get an optimized build without debug
symbols. If you use the proprietary nVidia driver and want to control your GPU
temperature, set USE_NVML:BOOL=ON.
To compile simply run:

 make

CMake should also provide you with a "make install" target, which defaults to
a /usr/local prefix.



Documentation
=============

Run thinkfan -h
Manpages: thinkfan(1), thinkfan.conf(5)
Example configs in examples/ subfolder
Search the web, lots of hints there
If all fails: https://github.com/vmatare/thinkfan/issues
