Changed the minor version to 3 for the conversion to pure C.

[breezed.git] / README.txt

diff --git a/README.txt b/README.txt
index 1434303..3185264 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -5,48 +5,31 @@
 
  * INSTALLATION
 
-   You can install it simply by running as root
+   Before installing, you must have a configuration file in
+   /etc/breezed.conf.
 
-     ./install.sh
+   Only one is currently provided in the archive, and it corresponds
+   to the settings _I_ picked for _my_ Lenovo X61s. I have no idea if
+   these settings are safe on this laptop (I guess so, since I have
+   been using them for a few months now and it works perfectly), and I
+   suspect they are not safe for another laptop. If you want to give
+   it a try, just
 
-   and de-install it with
+     cp breezed_Lenovo_X61s.conf /etc/breezed.conf
 
-     ./remove.sh
+   Then, you can install the daemon simply with
 
-   You must have a configuration file in /etc/breezed.conf. Only one
-   is currently provided in the archive, and it corresponds to the
-   settings _I_ picked for _my_ Lenovo X61s.
+     make install
 
-   I have no idea if these settings are safe on this laptop (I guess
-   so, since I have been using them for a few months now and it works
-   perfectly), and I suspect they are not safe for another laptop.
+   and uninstall it with
 
- * ALGORITHM
+     make uninstall
 
-   Breezed scans the temperatures every 5s and sets the fan speed
-   according to a series of thresholds.
-
-   Unfortunately, if the fan speed is set directly according to these
-   temperature thresholds, it creates oscillations: The fan goes up,
-   temperature goes down, hence fan goes down, temperature goes up,
-   etc.
-
-   To mitigate such phenomenons, the daemon waits at least 30s after
-   the last change before reducing the fan speed, and the actual
-   thresholds to decrease the fan speed are two degrees below the
-   provided thresholds, which are used when increasing the fan
-   speed. This creates a stability area of two degrees, which seems to
-   be enough. Please let me know if you have problem with the
-   resulting overall behavior.
-
-   See the man page for details about the arguments and configuration
-   file.
+   See the man page for details about the algorithm, arguments and
+   configuration file.
 
  * NOTES
 
-   I wrote this daemon for my personal usage on a X61s, and using it
-   may damage your hardware.
-
    On Thinkpads you have to allow the module thinkpad_acpi to set the
    fan speed, which is not allowed by default in Debian. To do so, you
    have to have a file /etc/modprobe.d/thinkpad_acpi.modprobe
@@ -58,4 +41,4 @@
 
 --
 Francois Fleuret (francois@fleuret.org)
-December 2008
+April 2009