diff options
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..70ddbfb --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# fastmouse + +Fastmouse is a kernel patch which provides the ability to rotate and slow your mouse. + +# Building from Source + +To download the latest available release, clone this repository. + +```console + $ git clone https://git.nj3.xyz/fastmouse --recurse-submodules + $ cd ./fastmouse +``` + +Compiling from source is a two step process. To avoid forking the Linux tree, +we use linux as a submodule and manipulate files as necessary during compilation. +Simply run `setup.sh` to create symlinks from the linux tree to our `src` directory. + +```console + $ ./setup.sh +``` + +Create a patch from `src` by running `patch.sh`. + +```console + $ ./patch.sh +``` + +`leetmouse.patch' will be in the placed in the topmost directory. + |