Skip to content

Commit

Permalink
docs: improving README
Browse files Browse the repository at this point in the history
  • Loading branch information
Gnarus-G committed Feb 2, 2024
1 parent edfe666 commit 7aa1895
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ acceleration factor

## Install

Make sure to have these dependencies installed on your machine:
`curl`, `git`, `make`, `gcc`, and the linux headers in `/lib/modules/`

```sh
curl -fsSL https://raw.githubusercontent.com/Gnarus-G/maccel/main/install.sh | sh
curl -fsSL https://raw.githubusercontent.com/Gnarus-G/maccel/main/install.sh | sudo sh
```

## Uninstall
Expand All @@ -31,7 +34,7 @@ sh /opt/maccel/uninstall.sh
Or

```sh
curl -fsSL https://raw.githubusercontent.com/Gnarus-G/maccel/main/uninstall.sh | sh
curl -fsSL https://raw.githubusercontent.com/Gnarus-G/maccel/main/uninstall.sh | sudo sh
```

## CLI Usage
Expand Down Expand Up @@ -71,3 +74,42 @@ Here is [Breakdown of why and how I ended up making this](https://www.bytin.tech
- https://github.com/a1xd/rawaccel/blob/master/doc/Guide.md
- https://github.com/Skyl3r/leetmouse/blob/master/driver/accel.c
- https://sourceforge.net/p/fixedptc/code/ci/default/tree/

## Troubleshooting Install

### gcc

The version matters, it must match the version with which the kernel was built.

For example you might such an error:

![image](https://github.com/Gnarus-G/maccel/assets/37311893/6147e20a-a132-4132-a45e-2af3dc035552)

And you'll have to find a version of `gcc` that matches. This will be more or less annoying
depending on your distro and/or how familiar you're familiar with it.

### linux headers

You want to make sure that `/lib/modules/` is not empty. For example mine looks like this:

```
total 0
drwxr-xr-x 1 root root 114 Jan 29 17:59 .
drwxr-xr-x 1 root root 159552 Jan 29 22:39 ..
drwxr-xr-x 1 root root 10 Jan 29 17:59 6.6.14-1-lts
drwxr-xr-x 1 root root 12 Jan 29 17:59 6.7.0-zen3-1-zen
drwxr-xr-x 1 root root 494 Jan 29 17:59 6.7.2-arch1-1
drwxr-xr-x 1 root root 494 Jan 31 21:54 6.7.2-zen1-1-zen
```

You want to find headers that match your kernel as represented by

```
uname -r
```

On an arch based distro you list the available headers with

```
sudo pacman -Ss linux headers
```

0 comments on commit 7aa1895

Please sign in to comment.