Skip to content

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

Update README.md

Soong-Vildabd4f4df986fa
diff --git a/README.md b/README.md
index aae47541..2d97e0fa 100755
--- a/README.md
+++ b/README.md
@@ -1,22 +1,25 @@
-# <center>Linux Kernel with several scheduler and other improvements</center>
+<div align="center">
+ <img src="https://github.com/CachyOS/calamares-config/blob/grub-3.2/etc/calamares/branding/cachyos/logo.png" width="64">
+ <h1 align="center">CachyOS</h1>
+ <p align="center">CachyOS ships improved kernels that improve performance and other aspects.</p>
+</div>
-## General Information
+## :globe_with_meridians: General Information about kernels
-CachyOS are improved kernels that improve performance and other aspects. The Schedulers listed below are supported:
+The Schedulers listed below are supported:
-### linux-cachyos will now use as default the BORE scheduler!
-
-- Standard Scheduler Completely Fair Scheduler (CFS) - linux-cachyos-cfs
-- CacULE and CacULE-RDB created from Hamad Marri, maintained by CachyOS - linux-cachyos-cacule
+### linux-cachyos uses as default the BORE scheduler
+- BORE (Burst-Oriented Response Enhancer) CPU Scheduler by [firelzrd (BORE)](https://github.com/firelzrd/bore-scheduler) - linux-cachyos-bore / linux-cachyos / linux-bore
+- Task Type Scheduler by [Hamad Marri (TT)](https://github.com/hamadmarri/TT-CPU-Scheduler) - linux-cachyos-tt / linux-tt
- BitMap Queue (BMQ) Alfred Chen Scheduler - linux-cachyos-bmq
- Priority and Deadline based Skiplist multiple queue scheduler (PDS) - Alfred Chen Scheduler » linux-cachyos-pds
-- Task Type Scheduler by [Hamad Marri (TT)](https://github.com/hamadmarri/TT-CPU-Scheduler) - linux-cachyos-tt / linux-tt
-- BORE (Burst-Oriented Response Enhancer) CPU Scheduler by [firelzrd (BORE)](https://github.com/firelzrd/bore-scheduler) - linux-cachyos-bore / linux-cachyos / linux-bore
+- CacULE and CacULE-RDB created from Hamad Marri, maintained by CachyOS - linux-cachyos-cacule
+- Standard Scheduler Completely Fair Scheduler (CFS) - linux-cachyos-cfs
-**All kernels are prebuilt in two different march versions (x86_64 and x86_64_v3) and also with the lto enabled kernels in the cachyos repo.**
-## Features
+> All kernels are prebuilt in two different march versions (x86-64 and x86-64-v3) and also with the LTO-enabled kernels in the cachyos repositories.
+## :dart: Features
- Very customizable PKGBUILD with many features and improvements
- 5 Different scheduler are supported, CacULE-,CFS-,tt-,bmq-,bore-, and pds scheduler
- GCC/CLANG Optimization with automatically found cpu arch or also selectable cpu arch
@@ -28,86 +31,97 @@ CachyOS are improved kernels that improve performance and other aspects. The Sch
- Latest LRU (v15) Patch-set, default enabled
- Maple Tree from linux-next
- MM Demotion from linux-next
-- Latency Nice Patchset included usuage with ananicy-cpp feature branch (https://lore.kernel.org/lkml/[email protected]/T/#t)
+- Latency Nice Patchset included usuage with ananicy-cpp [feature branch](https://lore.kernel.org/lkml/[email protected]/T/#t).
- NEST Scheduler
- rcu fixes and improvements
- latest DAMON improvements and fixes
- BBRv2 tcp_congestion_control
-- LLVM THIN-LTO Kernels prebuilt in x86-64-v3 and x86-64 in the CachyOS repo
+- LLVM THIN-LTO Kernels prebuilt in x86-64-v3 and x86-64 in the CachyOS repositories
- LRNG Framework (default enabled)
- Latest & improved ZSTD patch-set
- Latest BTRFS/XFS/EXT4 improvements & fixes
- KSMBD Module for Samba3 Server
- AMD PSTATE EPP Driver enabled by default and with enhancements patches/fixes
- Clearlinux Patchset
-- Kernel Control Flow Integrity (kCFI) selectable when using LLVM(patched llvm can be found in the cachyos-repo)
-- ZFS Filesystem Support and prebuilt in the repo!
+- Kernel Control Flow Integrity (kCFI) selectable when using LLVM(patched llvm can be found in the cachyos-repositories)
+- ZFS Filesystem Support and prebuilt in the repository
- WINESYNC Fastsync
-- Use entropy optimization for zram
+- Use entropy optimization for zRAM
- UserKSM daemon from pf
- support for bcachefs
-## Other distros
-
+## Other GNU/Linux distributions
- Complete patch for simple patching on the kernel
- It is planned to implement into our kernel builder from cachyos buildsystem, which works also on other distro
### Gentoo
-
-Its a community maintained ebuild from a user, which can be used for a dynamic building:
-(https://github.com/sandikata/ROKO__/tree/master/sys-kernel/cachyos-sources)
+Its a community maintained ebuild from a user, which can be used for a dynamic building right [here](https://github.com/sandikata/ROKO__/tree/master/sys-kernel/cachyos-sources)
Or simply run:
-
```
eselect repository enable ROKO__
emaint sync -r ROKO__
```
-## We are providing a [repo](https://mirror.cachyos.org/) which includes all kernels in generic-v3 and generic and more optimized packages
-
-### How to add our repo automatically with CPU detection (if x86-64-v3 is supported)
-
-**Just run following command:**
+## We are providing a [repositories](https://mirror.cachyos.org/) which includes all kernels in x86-64-v3 and x86-64 and more performance-optimized packages
+How to add our repositories automatically with compatibility detection (if x86-64-v3 is supported) is described below:
-## **Automatic `march` detection and changing the pacman.conf:**
+## 🦾 Automatic adding of our repositories
+Run following commands:
+1. Get archive with script
```
wget https://mirror.cachyos.org/cachyos-repo.tar.xz
+```
+
+2. Extract and jump into the archive
+```
tar xvf cachyos-repo.tar.xz && cd cachyos-repo
+```
+
+3. Run script under sudo
+```
sudo ./cachyos-repo.sh
```
-## **Manually**:
+> The script performs automatic `march` detection and changes the pacman.conf
-````
+## :hand: Manually
+1. Add key
+```
sudo pacman-key --recv-keys F3B607488DB35A47 --keyserver keyserver.ubuntu.com
+```
+2. Add key
+```
sudo pacman-key --lsign-key F3B607488DB35A47
+```
+3. You can download first initial packages
+```
sudo pacman -U 'https://mirror.cachyos.org/repo/x86_64/cachyos/cachyos-keyring-2-1-any.pkg.tar.zst' 'https://mirror.cachyos.org/repo/x86_64/cachyos/cachyos-mirrorlist-13-1-any.pkg.tar.zst' 'https://mirror.cachyos.org/repo/x86_64/cachyos/cachyos-v3-mirrorlist-13-1-any.pkg.tar.zst' 'https://mirror.cachyos.org/repo/x86_64/cachyos/pacman-6.0.2-6-x86_64.pkg.tar.zst'
+```
+## Checking x86-64-v3 cpu support
+1. Check support by the following the command
+```
+/lib/ld-linux-x86-64.so.2 --help | grep "x86-64-v3 (supported, searched)"
+```
- **Checking x86_64_v3 cpu support:**
-
- /lib/ld-linux-x86-64.so.2 --help | grep "x86-64-v3 (supported, searched)"
-
- add following under the arch repos the "-v3" repos only if they are supported:
- ```
- # cachyos repos
- ## Only add if your cpu does v3 architecture
- [cachyos-v3]
- Include = /etc/pacman.d/cachyos-v3-mirrorlist
- [cachyos]
- Include = /etc/pacman.d/cachyos-mirrorlist
- ````
-
-This script will also backup your old pacman.conf.
-
-This script will auto-detect you architecture, if your CPU have x86-64-v3 support, it will automatically use the repos which are optimized with this flag and some other flags.
+add following under the arch repos the "-v3" repos only if they are supported:
+```
+# cachyos repos
+## Only add if your CPU does v3 architecture
+[cachyos-v3]
+Include = /etc/pacman.d/cachyos-v3-mirrorlist
+[cachyos]
+Include = /etc/pacman.d/cachyos-mirrorlist
+```
-Also all provided Kernels, Browsers, ... are optimized and compiled.
+> This script will also backup your old pacman.conf.
+> This script will auto-detect you architecture, if your CPU have x86-64-v3 support, it will automatically use the repos which are optimized with this flag > and some other flags.
+> Also all provided Kernels, Browsers, ... are optimized and compiled.
-## How to Backup the config and use the native Arch Packages
+## :arrow_backward: 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`
@@ -116,30 +130,22 @@ Also all provided Kernels, Browsers, ... are optimized and compiled.
More information's you will find here [CachyOS](https://github.com/cachyos) or [Discord](https://discord.gg/k39qfrxPNa)
-## How to use CLANG/LLVM/LTO compiled Kernels on Nvidia driver with DKMS:
-
-Not needed anymore, just install the latest dkms version (3.0.2).
-
-## Support
-
-You can join the CachyOS Discord with the following link:
+## :wrench: How to use CLANG/LLVM/LTO compiled Kernels on Nvidia driver with DKMS:
+> Not needed anymore, just install the latest dkms version (3.0.2).
+## :speaking_head: Support - get in touch with CachyOS community
+### Discord
<https://discord.gg/qJqj94uFwE>
-or at telegram:
-
+### Telegram:
<https://t.me/+zCzPX4cAFjk1MTYy>
-## Donations are welcome for the compile server for the repo or a cup of coffee for maintain this repo
-
-<https://paypal.me/pttrr>
+## :seedling: Donations are welcome for the compile server for the repositories or a cup of coffee for maintain this repositories
+<https://paypal.me/pttrr> <br />
<https://www.patreon.com/CachyOS>
### Valueable Contributors
-
-[Hamad Marri](https://github.com/hamadmarri) for the CacULE Scheduler
-
-[Archlinux](https://archlinux.org) for the great linux operating system
-
-[And all other Kernel Developers and Supporters](https://github.com/torvalds/linux)
+[Hamad Marri](https://github.com/hamadmarri) for the CacULE Scheduler <br />
+[Archlinux](https://archlinux.org) for the great linux operating system <br />
+[And all other Kernel Developers and Supporters](https://github.com/torvalds/linux) <br />