Commit Graph

168 Commits (main)

Author SHA1 Message Date
Mitchell Hashimoto 77b038dcb6
update README 2025-10-30 13:14:23 -07:00
Rohan Alexander 6faf7fcac3
Add missing word to README.md (#9165) 2025-10-12 07:21:49 -07:00
Leah Amelia Chen f91e6f1764
docs: better integrate CONTRIBUTING into the README 2025-08-29 06:14:41 +08:00
Leah Amelia Chen 2701932475
docs: separate out HACKING.md from README.md
Also did some copy-editing and removed some things that haven't been
present in the codebase for a while (I thought we nuked conformance
stuff in 1.1 already...?)
2025-08-29 06:14:36 +08:00
Mitchell Hashimoto fb9c52ecf4
Nuke GLFW from Orbit
This deletes the GLFW apprt from the Ghostty codebase.

The GLFW apprt was the original apprt used by Ghostty (well, before
Ghostty even had the concept of an "apprt" -- it was all just a single
application then). It let me iterate on the core terminal features,
rendering, etc. without bothering about the UI. It was a good way to get
started. But it has long since outlived its usefulness.

We've had a stable GTK apprt for Linux (and Windows via WSL) and a
native macOS app via libghostty for awhile now. The GLFW apprt only
remained within the tree for a few reasons:

  1. Primarily, it provided a faster feedback loop on macOS because
     building the macOS app historically required us to hop out of the
     zig build system and into Xcode, which is slow and cumbersome.

  2. It was a convenient way to narrow whether a bug was in the
     core Ghostty codebase or in the apprt itself. If a bug was in both
     the glfw and macOS app then it was likely in the core.

  3. It provided us a way on macOS to test OpenGL.

All of these reasons are no longer valid. Respectively:

  1. Our Zig build scripts now execute the `xcodebuild` CLI directly and
     can open the resulting app, stream logs, etc. This is the same
     experience we have on Linux. (Xcode has always been a dependency of
     building on macOS in general, so this is not cumbersome.)

  2. We have a healthy group of maintainers, many of which have access
     to both macOS and Linux, so we can quickly narrow down bugs
     regardless of the apprt.

  3. Our OpenGL renderer hasn't been compatible with macOS for some time
     now, so this is no longer a useful feature.

At this point, the GLFW apprt is just a burden. It adds complexity
across the board, and some people try to run Ghostty with it in the real
world and get confused when it doesn't work (it's always been lacking in
features and buggy compared to the other apprts).

So, it's time to say goodbye. Its bittersweet because it is a big part
of Ghostty's history, but we've grown up now and it's time to move on.
Thank you, goodbye.

(NOTE: If you are a user of the GLFW apprt, then please fork the project
prior to this commit or start a new project based on it. We've warned
against using it for a very, very long time now.)
2025-07-04 14:12:18 -07:00
Mitchell Hashimoto 0a27aef508
README: note Xcode 26 requirement 2025-06-21 06:39:20 -07:00
Mitchell Hashimoto 7b8c2232d3
build: distribute gresource c/h with source tarball
This introduces the concept of a "dist resource" (specifically a
`GhosttyDist.Resource` type). This is a resource that may be present in
dist tarballs but not in the source tree. If the resource is present and
we're not in a Git checkout, then we use it directly instead of
generating it.

This is used for the first time in this commit for the gresource c/h
files, which depend on a variety of external tools (blueprint-compiler,
glib-compile-resources, etc.) that we do not want to require downstream
users/packagers to have and we also do not want to worry about them
having the right versions.

This also adds a check for `distcheck` to ensure our distribution
contains all the expected files.
2025-03-19 11:52:03 -07:00
CKay9 dc21ea9998 Fix typo: Alejanda → Alejandra in README.md 2025-03-19 13:38:38 +01:00
Mitchell Hashimoto dd6460bc77
update README 2024-12-21 13:07:35 -08:00
Mitchell Hashimoto f2d4170322
update README for release 2024-12-21 13:05:13 -08:00
Mitchell Hashimoto 0907425d8f
Add information about community config tool (#2914)
I never got a response in the Discord server about PRing this so I
figured I would open the PR anyways.

I thought it might be a good idea to add this info into the README for
all the testers currently using Ghostty. I also think it might be a good
idea to have this in place before Ghostty goes public to potentially cut
down on the number of incoming requests for help and support regarding
configuration files and the inevitable duplicate requests for GUI
settings.

If this isn't something you'd like to add, feel free to close this. If
you want it adjusted in some way, let me know!
2024-12-15 21:30:15 -08:00
Jon Parise a0ce70651a bash: re-enable automatic bash shell detection
Bash shell detection was originally disabled in #1823 due to problems
with /bin/bash on macOS.

Apple distributes their own patched version of Bash 3.2 on macOS that
disables the POSIX-style $ENV-based startup path:

e5397a7e74/bash-3.2/shell.c (L1112-L1114)

This means we're unable to perform our automatic shell integration
sequence in this specific environment. Standard Bash 3.2 works fine.

Knowing this, we can re-enable bash shell detection by default unless
we're running "/bin/bash" on Darwin. We can safely assume that's the
unsupported Bash executable because /bin is non-writable on modern macOS
installations due to System Integrity Protection.

macOS users can either manually source our shell integration script
(which otherwise works fine with Apple's Bash) or install a standard
version of Bash from Homebrew or elsewhere.
2024-12-14 17:31:28 -05:00
Borys Lykah 69e2537438 Preserve ZSH options in the shell integration 2024-12-12 12:56:21 -07:00
Zerebos f16c74fba6
Add information about community config tool 2024-12-09 17:20:50 -05:00
Mitchell Hashimoto 247409d705
New Ghostty icon
❤️👻

This is the icon that we'll launch Ghostty 1.0 with. It was designed by
Michael Flareup at PixelResort. It retains the style of the original
Ghostty icon by Alasdair Monk, but brings in the new Ghost character and
adds details that make it more Apple-like.

The new Ghost character is an important evolution from the original
since it separates us from looking too much like PacMan. The new Ghost
is more unique and recognizable to Ghostty (or, hopefully will be!).

The icon itself has more details: the aluminum around the edge has
texture for the large enough sizes, there are visible scanlines, the
glow of a screen emanates from the ghost.

The icon itself is stylistic more Apple-like than other platforms. I
think Apple icons tend to look very good in more environments than the
reverse and I'm a big fan of the Apple aesthetic so I wanted to bring
that to Ghostty for all platforms.
2024-12-09 10:01:18 -08:00
Mitchell Hashimoto f12ac32c97
README: clarify config docs location 2024-11-26 16:35:36 -08:00
Nico Elbers 34c3da4302
docs: fix the nixos install instructions
Not updating inputs resulted in a crash for me, this fixed it.

Relevant link from discord:
https://discord.com/channels/1005603569187160125/1301217629268213770
2024-11-05 21:57:51 +01:00
Mitchell Hashimoto 274759d391
Merge pull request #2589 from mnemnion/de-jure
ECMA 48 is de jure: as stated by law
2024-11-04 14:03:11 -08:00
Mitchell Hashimoto 21f5a2aa51
README: syntax highlight the config 2024-11-04 09:37:18 -08:00
Sam Atman c7413bcf57
ECMA 48 is de jure: as stated by law
I am actually not sure if this was meant as a sly pun. It definitely works that way, terminals are _de jour_ meaning _of the day_, but the contrastive with _de facto_  makes me lean toward typo / malaprop. 

The thing is it's a good pun, and I almost let it be for that reason. But I lean towards unintended, so here's a patch, feel free to close it if I read it wrong, er, right? Y'know.
2024-11-03 17:33:35 -10:00
Mitchell Hashimoto b14f0f95a9
remove -Dstatic 2024-10-24 15:16:40 -07:00
Mitchell Hashimoto 4c871246dd
update file sizes in README.md 2024-10-15 09:59:43 -07:00
Mitchell Hashimoto eec77e271c
macos: change our minimum version to macOS 13
macOS 12 is officially EOL by Apple and the project only supports
officially supported versions of macOS. Once publicly released, users on
older macOS versions will have to use older released builds.
2024-10-09 14:41:57 -07:00
Lucy Davinhart || Strawb System 1b024b117f
Include command to run a subset of tests in README
For Zig veterans this may be obvious. As a Zig newbie, for me it was no, but found the answer in the Discord.
2024-10-09 21:23:05 +01:00
Mitchell Hashimoto b7ac7bf336
README: note how to send crash reports to the project 2024-09-17 13:30:47 -07:00
Jeffrey C. Ollie 1a6c928951 update README 2024-09-10 20:43:00 -07:00
Mitchell Hashimoto b7c9dafab3
prettier 2024-09-10 11:23:55 -07:00
Leah Amelia Chen 8502034dae
README: document common issues on NixOS 2024-09-09 10:45:44 +02:00
Mitchell Hashimoto 12bf107bcb
update README 2024-09-08 21:30:07 -07:00
Mohammad H. AlShami 20fdd6ee9f Fix copied mistake 2024-09-07 13:10:59 -05:00
Mohammad H. AlShami 4ee615294b Add package names for Fedora variants 2024-09-07 13:06:36 -05:00
Mitchell Hashimoto 492b113de6
update README again 2024-09-03 10:28:59 -07:00
Mitchell Hashimoto 84f4743eed
update README to warn about crash report env vars 2024-09-03 10:26:10 -07:00
Mitchell Hashimoto f07cda07d6
update README about crashes 2024-09-02 10:14:32 -07:00
Mitchell Hashimoto 6877ba9f7f readme: clarify that comments are only allowed on a dedicated line 2024-08-18 19:01:47 -07:00
bri b371056bfb
its → it's 2024-07-30 13:44:53 -04:00
omar 252c0ef927
fix: remove dollar sign from code snippets
currently when copying code snippets one has to manually remove the dollar sign first. Consider:

```sh
$ echo "this can't be copy pasted into terminal because of the initial $"
```

vs.

```sh
echo "this is fine"
```
2024-07-17 14:18:23 -06:00
Kainoa Kanter d0bf2c6ac0
docs: AUR package
After finding out about ghostty from Jarred Sumner's Twitter, I immediately searched the AUR for a package and found `ghostty-git`, which should be perfect for keeping up with development as `-git` packages can be set to update with new pushes when updating your system!
2024-07-11 15:17:59 -07:00
Mitchell Hashimoto 31d5384920
macOS select output is cmd+tripleclick not control anymore
Fixes #1920

Ctrl interferes with context menus.
2024-07-07 14:01:20 -07:00
Mitchell Hashimoto f203124de0
prettier 2024-06-30 19:56:54 -07:00
Ben Linsay 50909107c4 Add a line to the README about config reload 2024-06-30 14:38:41 -04:00
Justin Restivo b0959ae189 docs: fix nix wiki 404 in README 2024-06-25 12:53:45 -04:00
Mitchell Hashimoto 69af3f3759
Merge pull request #1878 from sethvargo/sethvargo/docs
Clarify shell integration installation
2024-06-24 16:01:22 -07:00
Mitchell Hashimoto 2246da7207
prettier 2024-06-24 16:01:02 -07:00
Mitchell Hashimoto 00745f4caa
update README for Zig 0.13 2024-06-24 15:36:05 -07:00
Seth Vargo 881324b10b
Clarify shell integration installation 2024-06-24 18:18:17 -04:00
Jon Parise 7d7fa46b0c shell-integration: bash must be explicitly enabled
For now, bash integration must be explicitly enabled (by setting
`shell-integration = bash`). Our automatic shell integration requires
bash version 4 or later, and systems like macOS continue to ship bash
version 3 by default. This approach avoids the cost of performing a
runtime version check.
2024-06-03 20:34:29 -04:00
Mitchell Hashimoto 502423dabf
update README 2024-06-01 09:46:14 -07:00
Mitchell Hashimoto 8a5f2e18ab
update READMEs to new repo URL 2024-05-31 13:36:07 -07:00
Mitchell Hashimoto 51b6bf46bf
update README
Fixes #1773
2024-05-22 16:15:18 -04:00