jstm-optimized/README.md

# Rewrite
I am [planning a rewrite](https://git.staropensource.de/JeremyStarTM/jstm-optimized/issues/1) of this build tool and are unable to update the now old version due to multiple limitations how the build tool works internally.
This will take a bit of time and motivation, so please build and use [upstream](https://git.staropensource.de/JeremyStarTM/aur-linux-clear) instead for now.

# jstm-optimized
This repository includes a build tool for compiling the Linux kernel with performance patches from the Linux Clear project. It allows for build time speedups and easier PKGBUILD configuration.
This repository is based on the AUR package [linux-clear](https://aur.archlinux.org/pkgbase/linux-clear) (which is also maintained by me) and simply patches it's PKGBUILD file and passes some environment variables.

Before I took over the AUR package I maintained a softfork of the package here. Now it just contains tools for it as I am now able to introduce things to upstream.
## Warning
As with every other software, make sure to regularily update your kernel. Missing updates and security patches will make your system vulnerable to attacks.

## Changes
This repository improves/changes the following things over [linux-clear](https://aur.archlinux.org/pkgbase/linux-clear):
- includes a build tool with build time performance improvements
- defaults to cpu governor `schedutil` instead of `performance` (you don't need maximum performance 24/7 anyway, use [`gamemode`](https://github.com/FeralInteractive/gamemode) for maximum game performance or use [`cpu-power`](https://archlinux.org/packages/extra/x86_64/cpupower/))
- includes the `powersave` cpu governor for battery-powered devices

## Building
To build this kernel, run this command in your terminal:
```bash
curl -sSL "https://git.staropensource.de/JeremyStarTM/jstm-optimized/raw/branch/develop/buildtool.sh">/tmp/buildtool.sh
chmod +x /tmp/buildtool.sh
/tmp/buildtool.sh
```

## Building from local repository
If you've already built this kernel or want to compile the kernel from your local repository execute this:
```bash
env BUILDTOOL_LOCALDIR=SET ./buildtool.sh
```

## Cleaning repository
To remove everything `makepkg` produced, simply run:
```bash
./cleantool.sh
```