Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix various documentation inconsistencies #5

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+19 −21
Open

Fix various documentation inconsistencies #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9d859c
docs: fix incorrect make options
arkorty Oct 17, 2024
a5f4d9f
docs: add link to `make`
arkorty Oct 17, 2024
cc35cdd
docs: rename `AUTHORS` to `CONTRIBUTORS.md` and add new contributor
arkorty Oct 17, 2024
c4aff3e
docs: remove the link to source code
arkorty Oct 17, 2024
178e9ff
docs: fix inconsistencies
arkorty Oct 17, 2024
34fb35c
Merge branch 'Arkapravo-Ghosh:main' into main
arkorty Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion AUTHORS
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions CONTRIBUTORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Contributors

- Arkapravo-Ghosh <[email protected]>
- Arkaprabha Chakraborty <[email protected]>
2 changes: 1 addition & 1 deletion INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
33 changes: 14 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.