Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-08-02 14:57:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

update PACKAGING.md to be explicit about source vs. git

Browse Source 
Related to #7316
This commit is contained in:
Mitchell Hashimoto
2025-05-09 08:27:11 -07:00
parent bcff488095
commit 201ea050bd
1 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
PACKAGING.md
View File

@ -4,13 +4,12 @@ Ghostty relies on downstream package maintainers to distribute Ghostty to
end-users. This document provides guidance to package maintainers on how to end-users. This document provides guidance to package maintainers on how to
package Ghostty for distribution. package Ghostty for distribution.
> [!NOTE] > [!IMPORTANT]
> >
> While Ghostty went through an extensive private beta testing period, > This document is only accurate for the Ghostty source alongside it.
> packaging Ghostty is immature and may require additional build script > **Do not use this document for older or newer versions of Ghostty!** If
> tweaks and documentation improvement. I'm extremely motivated to work with > you are reading this document in a different version of Ghostty, please
> package maintainers to improve the packaging process. Please open issues > find the `PACKAGING.md` file alongside that version.
> to discuss any packaging issues you encounter.
## Source Tarballs ## Source Tarballs
@ -37,6 +36,19 @@ Use the `ghostty-source.tar.gz` asset and _not the GitHub auto-generated
source tarball_. These tarballs are generated for every commit to source tarball_. These tarballs are generated for every commit to
the `main` branch and are not associated with a specific version. the `main` branch and are not associated with a specific version.
> [!WARNING]
>
> Source tarballs are _not the same_ as a Git checkout. Source tarballs
> contain some preprocessed files that allow building Ghostty with less
> dependencies. If you are building Ghostty from a Git checkout, the
> steps below are the same but they may require additional dependencies
> not listed here. See the `README.md` for more information on building
> from a Git checkout.
>
> For everyone except Ghostty developers, please use the source tarballs.
> We generate tip source tarballs for users following the development
> branch.
## Zig Version ## Zig Version
[Zig](https://ziglang.org) is required to build Ghostty. Prior to Zig 1.0, [Zig](https://ziglang.org) is required to build Ghostty. Prior to Zig 1.0,
@ -81,13 +93,6 @@ for system packages which separate a build and install step, since the
install step can then be done with a `mv` or `cp` command (from `/tmp/ghostty` install step can then be done with a `mv` or `cp` command (from `/tmp/ghostty`
to wherever the package manager expects it). to wherever the package manager expects it).
> [!NOTE]
>
> **Version 1.1.1 and 1.1.2 are missing `fetch-zig-cache.sh`.** This was
> an oversight on the release process. You can use the script from version
> 1.1.0 to fetch the Zig cache for these versions. Future versions will
> restore the script.
### Build Options ### Build Options
Ghostty uses the Zig build system. You can see all available build options by Ghostty uses the Zig build system. You can see all available build options by