Skip to content

readme: refresh#1190

Open
AdelKS wants to merge 1 commit intoFrogging-Family:masterfrom
AdelKS:readme-update
Open

readme: refresh#1190
AdelKS wants to merge 1 commit intoFrogging-Family:masterfrom
AdelKS:readme-update

Conversation

@AdelKS
Copy link
Copy Markdown
Collaborator

@AdelKS AdelKS commented Mar 29, 2026

Hey @Tk-Glitch , @sirlucjan , @ptr1337 and anyone else interested.

Thought the readme needed a refresh, here it is. Input welcome for additions, changes, reverts... etc

Thanks!

Comment thread README.md
You can use an external config file (default is `$HOME/.config/frogminer/linux-tkg.cfg`, tweakable with the `_EXT_CONFIG_PATH` variable in `customization.cfg`). You can also use your own patches (more information in `customization.cfg` file).

- Keep in mind building recent linux kernels with GCC will require ~20-25GB of disk space. Using llvm/clang, LTO, ccache and/or enabling more drivers in the defconfig will push that requirement higher, so make sure you have enough free space on the volume you're using to build.
- In `intel_pstate` driver, frequency scaling aggressiveness has been changed with kernel 5.5 which results in stutters and poor performance in low/medium load scenarios (for higher power savings). As a workaround for our gaming needs, we are setting it to passive mode to make use of the `acpi_cpufreq` governor passthrough, keeping full support for turbo frequencies. It's combined with our aggressive ondemand governor by default for good performance on most CPUs while keeping frequency scaling for power savings. In a typical low/medium load scenario (Core i7 9700k, playing Mario Galaxy on Dolphin emulator) intel_pstate in performance mode gives a stuttery 45-50 fps experience, while passive mode + aggressive ondemand offers a locked 60 fps.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this comment entirely thinking is outdated, but I am still seeing a default intel_pstate=passive in the customization.cfg for the kernel command line. Input welcome

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Afaik the intel_pstate=passive thing is still needed (and even exacerbated from the feedback I got) for best perf on Intel CPUs on low/medium loads, which games tend to be for the most part.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep it! Maybe you have a shorter version ? it's a top of the readme and it feels like too much details at that point, maybe redirect to "Default tweaks" subsection and write more there then.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion here #1190 (comment)

Comment thread README.md
- Keep in mind building recent linux kernels with GCC will require ~20-25GB of disk space. Using llvm/clang, LTO, ccache and/or enabling more drivers in the defconfig will push that requirement higher, so make sure you have enough free space on the volume you're using to build.
- In `intel_pstate` driver, frequency scaling aggressiveness has been changed with kernel 5.5 which results in stutters and poor performance in low/medium load scenarios (for higher power savings). As a workaround for our gaming needs, we are setting it to passive mode to make use of the `acpi_cpufreq` governor passthrough, keeping full support for turbo frequencies. It's combined with our aggressive ondemand governor by default for good performance on most CPUs while keeping frequency scaling for power savings. In a typical low/medium load scenario (Core i7 9700k, playing Mario Galaxy on Dolphin emulator) intel_pstate in performance mode gives a stuttery 45-50 fps experience, while passive mode + aggressive ondemand offers a locked 60 fps.
- Nvidia's proprietary drivers might need to be patched if they don't support your chosen kernel OOTB: [Frogging-Family nvidia-all](https://github.com/Frogging-Family/nvidia-all) can do that automatically for you.
- Note regarding kernels older than 5.9 on Arch Linux: since the switch to `zstd` compressed `initramfs` by default, you will face an `invalid magic at start of compress` error by default. You can workaround the issue by editing `/etc/mkinitcpio.conf` to uncomment the `COMPRESSION="lz4"` (for example, since that's the best option after zstd) line and regenerating `initramfs` for all kernels with `sudo mkinitpcio -P`
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this bullet point entirely too 🤔

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 20-25GB disk space requirement was added because people kept opening issues about compilation failures "while they had more than enough disk space", and in the end they had like 10GB free or something before building. Same story when building in ramfs with 16GB machines.

The Nvidia stuff will break, so not sure why you'd remove that entirely. It could be updated though, with their "open" module and maybe a warning regarding recent releases and RC kernels.

The <5.9 thing can indeed go now that 5.4 LTS is gone.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah no, I was only talking about the very last bullet point: the rest didn't get removed, it's just that github didn't see the text as "moved" further down or something

@AdelKS AdelKS force-pushed the readme-update branch 5 times, most recently from 1337b2e to 01a4ab3 Compare March 29, 2026 16:05
Comment thread README.md Outdated
Comment thread README.md
Comment on lines +49 to +52
- Default `intel_pstate=passive` kernel option for Intel CPUs
- Default frequency scaling aggressiveness with kernel ≥ 5.5 is conservative, which results in stutters and poor performance in low/medium load scenarios (for better power saving).
- `intel_pstate=passive` make's use of the `acpi_cpufreq` governor passthrough, keeping full support for turbo frequencies.
- It's combined with our aggressive `ondemand` governor by default for good performance while still preserving power.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Tk-Glitch how about we put here, in the "Default tweaks" section ? It doesn't feel that important for me to be in the "important information" top-of-readme position 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants