From 293019309ae34ec87d7ffb4da8115050987d19c9 Mon Sep 17 00:00:00 2001
From: q3aql <q3aql@duck.com>
Date: Tue, 27 Aug 2024 15:46:09 +0200
Subject: [PATCH] README.md

---
 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8eb6bd9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+`freqcpu` - limit CPU frequency 
+
+## Syntax:
+
+```
+freqcpu -c  --> create initial configuration file
+freqcpu -d  --> run daemon for set CPU frequency
+freqcpu -r  --> set limit CPU frequency
+freqcpu -f  --> show current CPU frequency
+freqcpu -g  --> show current CPU governor
+freqcpu -o  --> show CPU cores
+freqcpu -h  --> show help
+```
+
+## Configuration:
+
+To create the initial configuration file, you must run the command: 
+
+```
+freqcpu -c
+```
+
+Then edit the `/etc/freqcpu/freqcpu.conf` file to your own values.
+
+## Example configuration file:
+
+cores_cpu=16
+freq_min=2000Mhz
+freq_max=3600Mhz
+governor=powersave
+
+## Boot with system:
+
+```
+sudo systemctl daemon-reload
+sudo systemctl enable freqcpu
+```
+
+## How to install:
+
+```
+git clone https://git.q3aql.dev/q3aql/freqcpu
+cd freqcpu
+sudo make install
+```
+
+## How to uninstall:
+
+```
+git clone https://git.q3aql.dev/q3aql/freqcpu
+cd freqcpu
+sudo make uninstall 
+```
+
+## Dependencies
+* bash
+* cpufrequtils
+* watch
+