You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
@@ -26,11 +27,37 @@ Step into the PakFu dojo: your Sensei demands tidy archives, sharp tools, and wo
26
27
27
28
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.
28
29
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
+
29
56
<details>
30
57
<summary><strong>Table of Contents</strong></summary>
31
58
59
+
-[Getting Started](#getting-started)
32
60
-[Overview](#overview)
33
-
-[Download](#download)
34
61
-[Highlights](#highlights)
35
62
-[Supported Formats](#supported-formats)
36
63
-[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
54
81
- Primary focus: browse, inspect, preview, extract, and rebuild archive content with a documented CLI.
55
82
- Project state: active development with frequent feature updates.
56
83
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
-
73
84
## Highlights
74
85
- Archive and folder support in both GUI and CLI.
75
86
- Dedicated standalone viewer windows for image, video, audio, and model files.
@@ -359,21 +370,22 @@ For full policy details, see `docs/RELEASES.md`.
0 commit comments