aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSepero <cowpie2000@hotmail.com>2013-02-01 01:00:01 -0500
committerSepero <cowpie2000@hotmail.com>2013-02-01 01:00:01 -0500
commit0ebffad5153974579b28cbcf2c3d6b9bb6cc3fce (patch)
treea97e4749066717a3566710b4af2567e5287d2726
parent3379b802dcd7ce909e2df0c86f5844443222e72e (diff)
Update README.md
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1e2142e..e903f34 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,14 @@
temp-throttle
=============
-A shell script for throttling system CPU frequency based on a desired maximum temperature
+A shell script for throttling system CPU frequency based on a desired maximum temperature.
+
+Set a desired maximum temperature for your system using this script. If the maximum tempurature is exeeded, the script will limit the speed of your CPU cores incrementally until the system is again below your desired maximum temperature. (If your system remains above maximum temperature after completely limiting your CPU cores, it will simply stay limited until temperatures drop below the maximum desired.)
+
+
+This script must be run with root priviledges. Only celcius temperatures are supported. This example will limit system temperatures to 80 Celcius:
+ sudo ./temp_throttle 80
+
+
+For more information and mildly user friendly instructions, see here:
+http://seperohacker.blogspot.com/2012/10/linux-keep-your-cpu-cool-with-frequency.html