initial

1 files changed, 47 insertions, 0 deletions

diff --git a/cpufreq/README b/cpufreq/README
new file mode 100644
index 00000000..45b6e2f2
--- /dev/null
+++ b/cpufreq/README
@@ -0,0 +1,47 @@
+SUMMARY
+-------
+
+MATE CPUFreq Applet is a CPU Frequency Scaling Monitor for MATE Panel. 
+
+FEATURES
+--------
+
+ - Support for proc or sys filesystems
+ - Support for multiprocessor systems
+ - It can be used as frequency selector
+
+PREREQUISITES
+-------------
+
+ - MATE 2 libraries
+ - MATE Panel libraries
+ - MATE-VFS libraries
+ - MateConf
+
+   
+FREQUENCY SELECTOR
+------------------
+
+The applet includes a generic command line tool to change the cpu frequency. 
+This tool is 'cpufreq-selector'. The cpufreq-selector will be installed under 
+$prefix/bin/ where $prefix is the prefix selected to compile the applet.
+Once the cpufreq-selector is installed it can be used from the command line
+
+ $ cpufreq-selector -f <frequency_in_KHz>
+ $ cpufreq-selector -g <governor>
+
+To change the frequency from the applet, simply click on the applet and 
+a menu will be shown with the list of available frequencies.
+
+The cpufreq-selector is installed suid root by default. 
+
+To not install the cpufreq-selector:
+
+ $ ./configure [options] --disable-frequency-selector
+
+To not install the cpufreq-selector suid root:
+
+ $ ./configure [options] --enable-suid=no
+
+
+