diff --git a/README.md b/README.md index 843955f..c9f5e51 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,16 @@ Based on [HATS-Installer-Payload](https://github.com/sthetix/HATS-Installer-Payl ## Documentation For detailed information about the installation process, see: -- **[INSTALLATION_PROCESS.md](INSTALLATION_PROCESS.md)** - Complete step-by-step breakdown of everything checked and done during installation/update -- **[DEBUG_INI.md](DEBUG_INI.md)** - Optional `sd:/config/omninx/debug.ini` parameters to skip install steps (for testing) -- **[PRESERVE_INI.md](PRESERVE_INI.md)** - Optional `sd:/config/omninx/preserve.ini` to skip deleting chosen paths in **update** mode +- **[docs/INSTALLATION_PROCESS.md](docs/INSTALLATION_PROCESS.md)** - Complete step-by-step breakdown of everything checked and done during installation/update +- **[docs/DEBUG_INI.md](docs/DEBUG_INI.md)** - Optional `sd:/config/omninx/debug.ini` parameters to skip install steps (for testing) +- **[docs/PRESERVE_INI.md](docs/PRESERVE_INI.md)** - Optional `sd:/config/omninx/preserve.ini` to skip deleting chosen paths in **update** mode ## Installation Modes ### Update Mode (OmniNX Detected) - Detected when version marker files (`1.0.0s`, `1.0.0l`, or `1.0.0oc`) are found - Performs selective deletion of specific directories/files -- Optional **`sd:/config/omninx/preserve.ini`**: user-listed `sd:/…` paths (with `=1`) are excluded from that cleanup (see [PRESERVE_INI.md](PRESERVE_INI.md)) +- Optional **`sd:/config/omninx/preserve.ini`**: user-listed `sd:/…` paths (with `=1`) are excluded from that cleanup (see [PRESERVE_INI.md](docs/PRESERVE_INI.md)) - Preserves user data, savegames, and installed games - Updates only necessary CFW components @@ -114,7 +114,7 @@ Use hekate or another bootloader to launch the payload: 7. Applies extras (RAM / Hekate-Pro choice) and removes the pack directory 8. Launches hekate (`sd:/bootloader/update.bin`) -Details: [INSTALLATION_PROCESS.md](INSTALLATION_PROCESS.md). Test runs can write a log via [`debug.ini`](DEBUG_INI.md) (`log=1`). +Details: [INSTALLATION_PROCESS.md](docs/INSTALLATION_PROCESS.md). Test runs can write a log via [`debug.ini`](docs/DEBUG_INI.md) (`log=1`). ## Variant Support @@ -130,27 +130,28 @@ The payload detects the pack variant from the staging directory presence and det ``` OmniNX-Installer-Payload/ -├── source/ # Main source code -│ ├── main.c # Entry point and main flow -│ ├── version.c # Version/variant detection -│ ├── version.h -│ ├── install.c # Installation logic -│ ├── install.h -│ ├── backup.c # Backup/restore operations -│ ├── backup.h -│ ├── deletion_lists.h # Arrays of paths to delete -│ ├── fs.c # File system operations -│ ├── fs.h -│ ├── gfx.c # Graphics utilities -│ ├── gfx.h -│ ├── nx_sd.c # SD card operations -│ ├── nx_sd.h -│ ├── link.ld # Linker script -│ └── start.S # Startup assembly -├── bdk/ # Blue Development Kit -├── Makefile # Build configuration -├── VERSION # Version file -└── README.md # This file +├── source/ # Payload source +│ ├── main.c # Entry point, detection, confirmation, launch +│ ├── install.c / install.h # Install flow, progress lines, menus, extras, preserve/debug ini +│ ├── install_update.c # Update mode: cleanup + move pack files +│ ├── install_clean.c # Clean mode: backup, wipe, restore +│ ├── deletion_lists_update.h # Paths removed in update mode +│ ├── deletion_lists_clean.h # Paths removed in clean mode +│ ├── backup.c / backup.h # User data + HorizonOC config backup/restore +│ ├── fs.c / fs.h # Delete/move/copy trees, logging +│ ├── version.c / version.h # Installation + pack variant detection +│ ├── gfx.c / gfx.h # Console graphics +│ ├── nx_sd.c / nx_sd.h # SD card mount +│ ├── screenshot.c # Capture button screenshots +│ ├── link.ld # Linker script +│ └── start.S # Startup assembly +├── bdk/ # Blue Development Kit +├── desktop/ # Windows desktop installer (C#) +├── tools/ # Deletion list generator/audit, RAM test payload +├── docs/ # Installation process, debug.ini, preserve.ini +├── Makefile # Build configuration +├── VERSION # Version file +└── README.md # This file ``` ## License diff --git a/DEBUG_INI.md b/docs/DEBUG_INI.md similarity index 100% rename from DEBUG_INI.md rename to docs/DEBUG_INI.md diff --git a/INSTALLATION_PROCESS.md b/docs/INSTALLATION_PROCESS.md similarity index 100% rename from INSTALLATION_PROCESS.md rename to docs/INSTALLATION_PROCESS.md diff --git a/PRESERVE_INI.md b/docs/PRESERVE_INI.md similarity index 100% rename from PRESERVE_INI.md rename to docs/PRESERVE_INI.md diff --git a/source/install.h b/source/install.h index 2cc49e3..6adb0fe 100644 --- a/source/install.h +++ b/source/install.h @@ -16,7 +16,7 @@ typedef enum { // If a sub-menu aborts to Hekate / update.bin (does not return if launch succeeds) void installer_launch_hekate_payload(void); -// Main installation function (optional debug: see DEBUG_INI.md in repo root) +// Main installation function (optional debug: see docs/DEBUG_INI.md) int perform_installation(omninx_variant_t pack_variant, install_mode_t mode); // Update mode operations (install_update.c)