diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 375a6ad..0000000 --- a/AUTHORS +++ /dev/null @@ -1 +0,0 @@ -Arkapravo-Ghosh \ No newline at end of file diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..54c5b2a --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,4 @@ +# Contributors + +- Arkapravo-Ghosh +- Arkaprabha Chakraborty diff --git a/INSTALLATION.md b/INSTALLATION.md index c520ddb..3c5ad33 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -5,7 +5,7 @@ Install the following packages: - [lm_sensors](https://github.com/lm-sensors/lm-sensors) -- `make` +- [make](https://www.gnu.org/software/make) ### Arch Linux diff --git a/README.md b/README.md index a09c1c2..804a0a4 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,31 @@ # asus-fan-mode -Fan Mode Control for Asus Vivobook 14X Pro OLED in Linux +Fan Mode Control for Asus Vivobook 14X Pro OLED in Linux. ![](https://img.shields.io/github/license/Arkapravo-Ghosh/asus-fan-mode) ![](https://img.shields.io/badge/platform-Linux-blue) -- [Click Here](src/main.py) for Source code. - ## Installation -> Installation Guide is written in [INSTALLATION.md](INSTALLATION.md). +Installation Guide is written in [INSTALLATION.md](INSTALLATION.md). ## Usage -- `sudo fan-mode --auto` - Automatically optimise fan speed as per usage -- `sudo fan-mode --full` - Force fan to run in full speed -- `fan-mode --status` - Get status of fan -- `fan-mode --setup` - To generate a default configuration file -- `fan-mode --help` for more information. - -## Disabling Automatic Recovery of Fan Mode on Reboot - -- `sudo systemctl disable --now fan-mode-recovery` +- `sudo fan-mode --auto` to automatically optimise fan speed as per usage +- `sudo fan-mode --full` to force fan to run in full speed +- `fan-mode --status` to get fan status +- `fan-mode --setup` to generate a default configuration file +- `fan-mode --help` for more information ## Make Options -- **clean** - Clean all the build artifacts. -- **compile** - Compile the program. -- **install** - Install the program. -- **remove** - Remove the program. -- **check** - Check for required tools. +- `help` to show help message +- `check` to check for build dependencies +- `clean` to clean all the build artifacts +- `build` to build the executable +- `install` to install the program +- `remove` to remove the program -### Known Issues +## Known Issues - GPU Fan Controlling is not supported yet.