Typo.

[breezed.git] / README.txt

diff --git a/README.txt b/README.txt
index 1434303..5d19008 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,56 +1,45 @@
 
    Breezed is a small daemon to control the speed of the fan,
-   depending on the current temperature of the computer. I have tested
-   it only on a Thinkpad X61s.
+   depending on the current temperature of the computer.
 
- * INSTALLATION
+   DISCLAIMER: I have tested it only on my Thinkpads (X61s, T420s, and
+   T450s) with Debian stable.
 
-   You can install it simply by running as root
+ * INSTALLATION
 
-     ./install.sh
+   Before installing, you must have a configuration file in
+   /etc/breezed.conf.
 
-   and de-install it with
+   Three configuration files are provided, and correspond to the
+   settings *I* picked for my Lenovo Thinkpads. I guess they are okay
+   on these machines since I have been using them for years without
+   any particular problems, but I have no idea how this translates to
+   other laptops.
 
-     ./remove.sh
+   If you want to give it a try, just copy of the configuration file,
+   e.g.
 
-   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.
+     cp breezed_Lenovo_X61s.conf /etc/breezed.conf
 
-   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.
+   Then install the daemon on a systemd machine simply with
 
- * ALGORITHM
+     make install
 
-   Breezed scans the temperatures every 5s and sets the fan speed
-   according to a series of thresholds.
+   and uninstall it with
 
-   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.
+     make uninstall
 
-   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.
+   Use respectively install-sysv and uninstall-sysv to install it
+   through /etc/init.d.
 
-   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
-   containing
+   fan speed, which is not allowed by default in Debian. To do so, add
+   a file /etc/modprobe.d/thinkpad_acpi.conf containing
 
    ---------------------------- snip snip -------------------------------
    options thinkpad_acpi fan_control=1
@@ -58,4 +47,4 @@
 
 --
 Francois Fleuret (francois@fleuret.org)
-December 2008
+Aug 2016