Skip to content

Commit c82dfb0

Browse files
committed
Add Getting Started section and Credits badge
Introduce a new "Getting Started" section with platform release/package guidance, CLI hints, and build-from-source pointers to improve onboarding. Add a Credits badge linking to docs/CREDITS.md, consolidate the previous "Download" content into the new section, clarify packaged user-guide behavior, and reformat the Documentation list and Credits wording for clarity.
1 parent 2a9322e commit c82dfb0

1 file changed

Lines changed: 42 additions & 30 deletions

File tree

README.md

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<a href="https://github.com/themuffinator/PakFu/releases"><img alt="Download" src="https://img.shields.io/badge/download-GitHub%20Releases-2EA44F?style=for-the-badge"></a>
1717
<a href="docs/DEPENDENCIES.md"><img alt="Dependencies" src="https://img.shields.io/badge/docs-Dependencies-444444?style=for-the-badge"></a>
1818
<a href="docs/RELEASES.md"><img alt="Release Policy" src="https://img.shields.io/badge/docs-Release%20Policy-444444?style=for-the-badge"></a>
19+
<a href="docs/CREDITS.md"><img alt="Credits" src="https://img.shields.io/badge/docs-Credits-6F42C1?style=for-the-badge"></a>
1920
</p>
2021

2122
<p align="center">
@@ -26,11 +27,37 @@ Step into the PakFu dojo: your Sensei demands tidy archives, sharp tools, and wo
2627

2728
PakFu is a cross-platform archive manager and asset viewer for idTech-era and adjacent game formats. It is built with modern C++ and Qt6, and it keeps both GUI and CLI workflows first-class.
2829

30+
## Getting Started
31+
32+
Pick the path that matches what you want to do first:
33+
34+
| Goal | Start here |
35+
|---|---|
36+
| Install or update PakFu | Download the latest Windows, macOS, or Linux package from [GitHub Releases](https://github.com/themuffinator/PakFu/releases). Prefer the installer for your platform unless you specifically want a portable copy. |
37+
| Open archives in the GUI | Launch PakFu, add or auto-detect your game installation, then open a `.pak`, `.pk3`, `.pk4`, `.zip`, `.wad`, supported resource archive, or folder. |
38+
| Use PakFu from scripts | Run `pakfu --cli --help`, then see the [CLI quick reference](#cli-quick-reference) for listing, extracting, validating, converting, and update checks. |
39+
| Build from source | Install the [dependencies](docs/DEPENDENCIES.md), then follow [Build and Run](#build-and-run). |
40+
41+
Release packages follow a consistent shape:
42+
- Windows: `installer.msi` (recommended) or `portable.zip`
43+
- macOS: `installer.pkg` (recommended) or `portable.zip`
44+
- Linux: `installer.AppImage` (recommended) or `portable.tar.gz`
45+
46+
The Linux portable archive is a deployed runtime tree with Qt and non-Qt
47+
runtime libraries bundled. After extracting it, run `./pakfu` from the extracted
48+
directory.
49+
50+
PakFu can also check for updates at runtime (GUI) and via CLI (`--check-updates`).
51+
Every installer and portable package includes an offline HTML user guide in a
52+
`Documentation` folder (or the platform's app documentation location). The guide
53+
is generated from the user-facing sections of this README, so packaged help stays
54+
aligned without carrying build instructions or repository maintenance notes.
55+
2956
<details>
3057
<summary><strong>Table of Contents</strong></summary>
3158

59+
- [Getting Started](#getting-started)
3260
- [Overview](#overview)
33-
- [Download](#download)
3461
- [Highlights](#highlights)
3562
- [Supported Formats](#supported-formats)
3663
- [Build and Run](#build-and-run)
@@ -54,22 +81,6 @@ PakFu is a cross-platform archive manager and asset viewer for idTech-era and ad
5481
- Primary focus: browse, inspect, preview, extract, and rebuild archive content with a documented CLI.
5582
- Project state: active development with frequent feature updates.
5683

57-
## Download
58-
Get PakFu from GitHub Releases:
59-
- Windows: `installer.msi` (recommended) or `portable.zip`
60-
- macOS: `installer.pkg` (recommended) or `portable.zip`
61-
- Linux: `installer.AppImage` (recommended) or `portable.tar.gz`
62-
63-
The Linux portable archive is a deployed runtime tree with Qt and non-Qt
64-
runtime libraries bundled. After extracting it, run `./pakfu` from the extracted
65-
directory.
66-
67-
PakFu can also check for updates at runtime (GUI) and via CLI (`--check-updates`).
68-
Every installer and portable package includes an offline HTML user guide in a
69-
`Documentation` folder (or the platform's app documentation location). The guide
70-
is generated from the user-facing sections of this README, so packaged help stays
71-
aligned without carrying build instructions or repository maintenance notes.
72-
7384
## Highlights
7485
- Archive and folder support in both GUI and CLI.
7586
- Dedicated standalone viewer windows for image, video, audio, and model files.
@@ -359,21 +370,22 @@ For full policy details, see `docs/RELEASES.md`.
359370
| `QT_MEDIA_BACKEND` | Override Qt multimedia backend selection. |
360371

361372
## Documentation
362-
- `docs/CORE_LIBRARY.md` : `pakfu_core` public headers, API metadata, install contract, and sample consumer code.
363-
- `docs/DEPENDENCIES.md` : dependency baseline and optional libraries.
364-
- `docs/EXTENSIONS.md` : manifest schema, JSON payload contract, and CLI/GUI extension workflow.
365-
- `examples/extensions/` : source-first extension examples for local development and plugin-report smoke checks.
366-
- `docs/QA_ARCHIVE_FILE_OPS.md` : practical QA checklist for selection, drag/drop, cut/copy/paste, and modifiers.
367-
- `docs/RELEASES.md` : versioning, release rules, and asset contract.
368-
- `docs/UI_BUTTON_ICONS.md` : UI action icon inventory.
369-
- `docs/FILE_ASSOCIATION_ICONS.md` : file association icon mapping and implementation notes.
370-
- `docs/CREDITS.md` : project attributions, compatibility acknowledgements, and third-party credits.
371-
- `CHANGELOG.md` : release-by-release change history.
372-
- `scripts/build_user_guide.py` : generates the packaged HTML user guide from the user-facing README sections.
373+
- [Core library](docs/CORE_LIBRARY.md): `pakfu_core` public headers, API metadata, install contract, and sample consumer code.
374+
- [Dependencies](docs/DEPENDENCIES.md): dependency baseline and optional libraries.
375+
- [Extensions](docs/EXTENSIONS.md): manifest schema, JSON payload contract, and CLI/GUI extension workflow.
376+
- [Extension examples](examples/extensions/): source-first extension examples for local development and plugin-report smoke checks.
377+
- [Archive file operations QA](docs/QA_ARCHIVE_FILE_OPS.md): practical QA checklist for selection, drag/drop, cut/copy/paste, and modifiers.
378+
- [Release policy](docs/RELEASES.md): versioning, release rules, and asset contract.
379+
- [UI button icons](docs/UI_BUTTON_ICONS.md): UI action icon inventory.
380+
- [File association icons](docs/FILE_ASSOCIATION_ICONS.md): file association icon mapping and implementation notes.
381+
- [Credits and acknowledgements](docs/CREDITS.md): project attributions, compatibility acknowledgements, and third-party credits.
382+
- [Changelog](CHANGELOG.md): release-by-release change history.
383+
- [User guide builder](scripts/build_user_guide.py): generates the packaged HTML user guide from the user-facing README sections.
373384

374385
## Credits
375-
- Creator: themuffinator (DarkMatter Productions)
376-
- Full attribution list: `docs/CREDITS.md`
386+
PakFu is created by themuffinator (DarkMatter Productions), with project attributions,
387+
compatibility acknowledgements, and third-party credits maintained in the
388+
[credits document](docs/CREDITS.md).
377389

378390
## Tech Stack
379391
- Language: C++20

0 commit comments

Comments
 (0)