Skip to content

Archlinux Kernel based on different schedulers and some other performance improvements.

improve structure of readme

Soong-Vilda7fa8d2d63ed7
diff --git a/README.md b/README.md
index 677360ef..728a4c99 100755
--- a/README.md
+++ b/README.md
@@ -5,13 +5,26 @@
<p align="center">CachyOS ships improved kernels that improve performance and other aspects.</p>
</div>
-## 🌐 General Information about kernels
-The Schedulers listed below are supported:
-### 🧬 linux-cachyos uses as default the BORE scheduler
+- [General Information about kernels](#general-information-about-kernels)
+ - [linux-cachyos](#linux-cachyos)
+ - [Features](#features)
+- [CachyOS repositories](#cachyos-repositories)
+ - [How to add CachyOS repositories](#how-to-add-cachyos-repositories)
+ - [Check CPU compatibility](#check-cpu-compatibility)
+- [Other GNU/Linux distributions](#other-gnulinux-distributions)
+ - [Gentoo](#gentoo)
+ - [Fedora](#fedora)
+ - [Revert changes](#revert-changes)
+ - [Support](#support)
+
+# General Information about kernels
+The Schedulers listed below are supported
+
+## linux-cachyos
We provided all of these CPU schedulers because each scheduler performs differently and depends on usage. Please test it and choose what suits your requirements.
- **(BORE) - Burst-Oriented Response Enhancer** Scheduler by [firelzrd (BORE)](https://github.com/firelzrd/bore-scheduler)
- - `linux-cachyos` - Default kernel and we decided to ship BORE by default, but the scheduler could be changed in the future.
+ - `linux-cachyos` - Default kernel and we decided to ship **BORE** by default, but the scheduler could be changed in the future.
- `linux-cachyos-bore` - If we decide to change the scheduler in the future, we still want to provide BORE.
- **(TT) - Task Type** Scheduler by [Hamad Marri](https://github.com/hamadmarri/TT-CPU-Scheduler) - `linux-cachyos-tt` / `linux-tt`
- **(BMQ) - BitMap Queue** by Alfred Chen - `linux-cachyos-bmq`
@@ -23,23 +36,23 @@ We provided all of these CPU schedulers because each scheduler performs differen
***ATTENTION:** Not supported after version 6.1. If you still want to use it, you can get it from the archive repository - [linux-cacule](https://github.com/ptr1337/linux-cacule)*
> All kernels are prebuilt in two different march versions **(x86-64, x86-64-v3 and x86-64-v4)** and also with the **LTO-enabled** kernels in the cachyos repositories.
-## 🎯 Features
+## Features
Here is a list of features of linux kernels prebuilt in `x86-64-v4`, `x86-64-v3` and `x86-64` in the CachyOS repositories.
-#### :hammer_and_wrench: Advanced building & compiling
+### :hammer_and_wrench: Advanced building & compiling
- Very customizable PKGBUILD with many features and improvements.
- `GCC/CLANG` Optimization with automatically found CPU architecture or also selectable CPU architecture.
- Choose between `LLVM/LTO & Thin-LTO` or `GCC` - *experimental GCC LTO support is available.*
- Choose between 300Hz, 500Hz, 600 Hz ,750Hz and 1000Hz. Defaults to 500Hz for BORE/CFS and 1000Hz for other schedulers.
- Kernel Control Flow Integrity (kCFI) selectable when using `LLVM` - *patched llvm can be found in the cachyos-repositories.*
-#### :abacus: CPU enhancements
+### :abacus: CPU enhancements
- 5 Different scheduler are supported,`CFS`,`tt`,`bmq`,`bore`, and `pds` scheduler.
- AMD PSTATE EPP Driver enabled by default and with enhancements patches/fixes.
- Latency Nice Patchset included usuage with `ananicy-cpp` [feature branch](https://lore.kernel.org/lkml/[email protected]/T/#t).
- RCU fixes and improvements.
-#### :bookmark_tabs: Filesystem & memory
+### :bookmark_tabs: Filesystem & memory
- Latest BTRFS/XFS/EXT4 improvements & fixes.
- ZFS Filesystem Support and prebuilt in the repository.
- Latest & improved ZSTD patch-set.
@@ -48,11 +61,11 @@ Here is a list of features of linux kernels prebuilt in `x86-64-v4`, `x86-64-v3`
- support for bcachefs.
- [per VMA lock](https://lore.kernel.org/lkml/[email protected]/T/#ma04517b963591298a9eb76d96d2c453256a4d9ab) - *default disabled*
-#### &#128423; Network
+### &#128423; Network
- BBRv2 tcp_congestion_control.
- KSMBD Module for Samba3 Server.
-#### :arrow_heading_down: Other features
+### :arrow_heading_down: Other features
- Clearlinux Patchset.
- Back-ported patches from `linux-next`.
- Scheduler patches from linux-next/tip.
@@ -62,10 +75,14 @@ Here is a list of features of linux kernels prebuilt in `x86-64-v4`, `x86-64-v3`
- Futex fixes and winesync is available.
- OpenRGB and ACS Override support.
-## We are providing a [repositories](https://mirror.cachyos.org/) which includes all kernels in x86-64-v4,x86-64-v3 and x86-64 and more performance-optimized packages
-How to add cachyos repositories automatically with compatibility detection is described below.
+# [CachyOS repositories](https://mirror.cachyos.org/)
+Repositories contain Arch Linux and CachyOS unique packages, but re-build with flags focused on performance, stability and security.
+- `x86-64-v4` - currently only kernel packages + LTO.
+- `x86-64-v3` - all Arch Linux packages + LTO.
+- `x86-64` - all Arch Linux packages + LTO.
-## 🦾 Automatic adding of cachyos repositories
+## How to add CachyOS repositories
+### 🦾 Automatic adding of cachyos repositories
Run following commands:
1. Get archive with script
```
@@ -87,7 +104,7 @@ sudo ./cachyos-repo.sh
1. Script will auto-detect CPU architecture, if CPU have `x86-64-v4` or `x86-64-v3` support, script will automatically use the repositories which are optimized with this flag > and some other flags.
2. Script will backup your old `pacman.conf`.
-## βœ‹ Manually
+### Manually
1. Add both keys
```
sudo pacman-key --recv-keys F3B607488DB35A47 --keyserver keyserver.ubuntu.com
@@ -222,20 +239,21 @@ If you build external modules (e.g. for Nvidia graphics card drivers) and use th
sudo dnf install clang clang-devel llvm lld
```
-## ◀️ How to Backup the config and use the native Arch Packages
+## Revert changes
+ How to Backup the config and use the native Arch Packages
- Remove or Backup the config located at /etc/pacman.conf
- then run `sudo mv /etc/pacman.conf.bak /etc/pacman.conf`
- Then run following command to switch the packages to the default arch packages `sudo pacman -Suuy`
-## πŸ”§ How to use CLANG/LLVM/LTO compiled Kernels on Nvidia driver with DKMS
+## How to use CLANG/LLVM/LTO compiled Kernels on Nvidia driver with DKMS
> Not needed anymore, just install the latest dkms version from our repo.
-## πŸ—£οΈ Support - get in touch with CachyOS community
+## Support
**Discord:** <https://discord.gg/qJqj94uFwE> <br />
**Telegram:** <https://t.me/+zCzPX4cAFjk1MTYy> <br />
**Matrix:** <https://matrix.cachyos.org> <br />
-## 🌱 Donations are welcome for the build server for the repositories or a cup of coffee for maintaining our repositories.
+## Donations are welcome for the build server for the repositories or a cup of coffee for maintaining our repositories.
**PayPal:** <https://paypal.me/pttrr> <br />
**Patreon:** <https://www.patreon.com/CachyOS> <br />
**BTC:** bc1qmwglfchlc335du6pcu6w64cexu7cck0mzhyw42 <br />