Skip to content

Commit

Permalink
Merge pull request #22 from xalt7x/main
Browse files Browse the repository at this point in the history
Update readme: recommend git package and use "sudo" commands
  • Loading branch information
frederik-h authored May 13, 2023
2 parents b5be987 + 2c3dfc6 commit 2e57c4a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Make sure that you have the kernel headers for your kernel installed
and type `make` in the cloned project directory. In more detail,
on a Debian or Ubuntu system, you can build by:
```
sudo apt install build-essential linux-headers-$(uname -r)
sudo apt install build-essential linux-headers-$(uname -r) git
git clone https://github.com/frederik-h/acer-wmi-battery.git
cd acer-wmi-battery
make
Expand All @@ -34,20 +34,20 @@ Loading the module without any parameters does not
change any health or calibration mode settings of your system:

```
insmod acer-wmi-battery.ko
sudo insmod acer-wmi-battery.ko
```

### Health mode

The charge limit can then be enabled as follows:
```
echo 1 > /sys/bus/wmi/drivers/acer-wmi-battery/health_mode
echo 1 | sudo tee /sys/bus/wmi/drivers/acer-wmi-battery/health_mode
```

Alternatively, you can enable it at module initialization
time:
```
insmod acer-wmi-battery.ko enable_health_mode=1
sudo insmod acer-wmi-battery.ko enable_health_mode=1
```

### Calibration mode
Expand All @@ -56,7 +56,7 @@ Before attempting the battery calibration, connect
your laptop to a power supply. The calibration mode
can be started as follows:
```
echo 1 > /sys/bus/wmi/drivers/acer-wmi-battery/calibration_mode
echo 1 | sudo tee /sys/bus/wmi/drivers/acer-wmi-battery/calibration_mode
```


Expand All @@ -69,7 +69,7 @@ the calibration mode should be manually disabled
since the WMI event that indicates the completion
of the calibration is not yet handled by the module:
```
echo 0 > /sys/bus/wmi/drivers/acer-wmi-battery/calibration_mode
echo 0 | sudo tee /sys/bus/wmi/drivers/acer-wmi-battery/calibration_mode
```

### Related work
Expand Down

0 comments on commit 2e57c4a

Please sign in to comment.