From 3dce26b03df48ac8019d69e84f8f4ba5675d0ccf Mon Sep 17 00:00:00 2001 From: Dominator <160497584+dominatorul@users.noreply.github.com> Date: Fri, 10 Oct 2025 23:16:11 +0300 Subject: [PATCH] Update README.md --- README.md | 108 ++++++++++++++++++++++-------------------------------- 1 file changed, 44 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index c7e507db..73219487 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,15 @@ +
- -

- logo
- - Horizon OC - -

- -

- Advanced Open Source Overclocking Tool for Nintendo Switch (Atmosphere CFW) -

+logo --- - ![License: GPL-2.0](https://img.shields.io/badge/GPL--2.0-red?style=for-the-badge) -![Nintendo Switch](https://img.shields.io/badge/Nintendo_Switch-E60012?style=for-the-badge&logo=nintendo-switch&logoColor=white) -[![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/S3eX47dHsB) -![VSCode](https://img.shields.io/badge/VSCode-0078D4?style=for-the-badge&logo=visual%20studio%20code&logoColor=white) -![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge&logo=c%2B%2B&logoColor=white) +![Nintendo Switch](https://img.shields.io/badge/Nintendo_Switch-E60012?style=for-the-badge\&logo=nintendo-switch\&logoColor=white) +[![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge\&logo=discord\&logoColor=white)](https://discord.com/invite/S3eX47dHsB) +![VSCode](https://img.shields.io/badge/VSCode-0078D4?style=for-the-badge\&logo=visual%20studio%20code\&logoColor=white) +![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge\&logo=c%2B%2B\&logoColor=white) ![Downloads](https://img.shields.io/github/downloads/souldbminersmwc/Horizon-OC/total.svg?style=for-the-badge) --- @@ -28,79 +18,79 @@ ## ⚠️ Disclaimer -> **THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION.** -> Overclocking RAM can cause **NAND DAMAGE** due to Horizon OS design. -> Always ensure you have a **full NAND backup** before proceeding. +> **THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION.** +> Due to the design of Horizon OS, **overclocking RAM can cause NAND DAMAGE.** +> Ensure you have a **full NAND backup** before proceeding. --- ## 🌀 About -**Horizon OC** is an **open-source overclocking suite** for Nintendo Switch consoles running **Atmosphere** custom firmware. -It provides safe and flexible control over CPU, GPU, and RAM frequencies, with a modern configuration utility. +**Horizon OC** is an open-source overclocking tool for Nintendo Switch consoles running **Atmosphere custom firmware**. +It enables advanced CPU, GPU, and RAM tuning with user-friendly configuration tools. --- ## 🚀 Features -✅ CPU up to **2397MHz** (Mariko) / **2091MHz** (Erista) -✅ GPU up to **1305MHz** (Mariko) / **998MHz** (Erista) -✅ RAM up to **3200MHz** (Mariko) / **2360MHz** (Erista) -✅ Overclock & undervolt support -✅ Built-in configuration tool -✅ Compatible with most homebrew +* **CPU:** Up to `2397MHz` (Mariko) / `2091MHz` (Erista) +* **GPU:** Up to `1305MHz` (Mariko) / `998MHz` (Erista) +* **RAM:** Up to `3200MHz` (Mariko) / `2360MHz` (Erista) +* Over/undervolting support +* Built-in configurator +* Compatible with most homebrew -> ⚡ *Higher (potentially dangerous) frequencies are unlockable.* -> ⚙️ *Exact maximums vary per console.* +> ⚡ *Higher (potentially dangerous) frequencies are unlockable.* +> ⚙️ *Exact maximum values vary per console.* --- ## 🧩 Installation -1. Install the latest versions of: - - [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere) - - [Ultrahand Overlay](https://github.com/ppkantorski/Ultrahand-Overlay) +1. Ensure you have the latest versions of -2. Download the latest `hoc.kip` from the [Releases](../../releases) tab. -3. If using **Hekate**, edit `hekate_ipl.ini`: - ```ini + * [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere) + * [Ultrahand Overlay](https://github.com/ppkantorski/Ultrahand-Overlay) +2. Download the latest **hoc.kip** file from the [Releases](../../releases) tab. +3. If using **Hekate**, edit `hekate_ipl.ini` to include: + + ``` kip1=atmosphere/kips/* -```` + ``` -*(No edits needed if using fusee.)* - -4. Download and extract the **Horizon OC sysmodule** to your SD card root. -5. Optionally, use the **Configurator** to install automatically via GUI. + *(No changes needed if using fusee.)* +4. Download and extract the **Horizon OC sysmodule** to the root of your SD card. +5. Alternatively, use the **Configurator** and click the **Install** buttons for automatic setup. --- ## ⚙️ Configuration -1. Download the **Configurator** on your PC. +1. Download the latest **Configurator** on your computer. 2. Run the executable. -3. Select your SD card or UMS device. -4. Adjust frequency settings. +3. Select your SD card or UMS drive. +4. Adjust overclocking settings as desired. 5. Click **Save** to apply your configuration. --- ## 🧱 Building from Source -1. Set up a build environment for **Atmosphere**. -2. Clone the repo: +1. Set up a development environment for compiling **Atmosphere**. +2. Clone Atmosphere: ```bash git clone https://github.com/Atmosphere-NX/Atmosphere.git ``` -3. Move it into the `build/` folder. -4. Copy your `Source/stratosphere` folder into `build/`. -5. Build with: +3. Move the cloned folder into `build/`. +4. Insert your `Source/stratosphere` folder into `build/`. +5. Run: ```bash ./build.sh ``` -**Build the Configurator:** +To build the Configurator: ```bash cd Source/Configurator @@ -113,19 +103,9 @@ python -m PyInstaller --onefile --add-data "assets;assets" --icon=assets/icon.ic ## 💎 Credits -| Contributor | Contribution | -| ------------------------------- | ---------------------- | -| **Lightos**, **Dominatorul** | RAM timings | -| **KazushiMe**, **meha** | Switch-OC-Suite | -| **sys-clk team** | sys-clk base | -| **b0rd2death** | Ultrahand sys-clk fork | -| **Lightos**, **Sammybigio2011** | Early testing | +* **Lightos** & **Dominatorul** – RAM timings +* **KazushiMe** & **meha** – Switch-OC-Suite +* **sys-clk team** – sys-clk +* **b0rd2death** – Ultrahand sys-clk fork +* **Lightos** & **Sammybigio2011** – Early testing ---- - -
- -💻 *Built with ❤️ by the Horizon OC community*
-⭐ Star this repo if you find it useful! - -