add README for testers

This commit is contained in:
Mitchell Hashimoto
2023-08-03 10:50:21 -07:00
parent 674bdac024
commit bd1991f6f4
3 changed files with 73 additions and 5 deletions

View File

@ -15,6 +15,10 @@
·
<a href="#developing-ghostty">Developing</a>
</p>
<br>
<p align="center">
<a href="https://github.com/mitchellh/ghostty/blob/main/README_TESTERS.md"><b>Testers! Read This Too!</b></a>
</p>
</p>
## About
@ -35,10 +39,9 @@ terminal emulator that aims to remain compatible with all existing shells
and software. You can use this as a drop-in replacement for your existing
terminal emulator.
**Project Status:** Alpha. It is a minimal terminal emulator that can be used
for day-to-day work. It is missing many nice to have features but as a minimal
terminal emulator it is ready to go. I've been using it full time since
April 2022.
**Project Status:** Beta. Ghostty implements most of the baseline features
you'd expect for a terminal you can work in every day. We're still missing
things, but I've been using it full time since April 2022.
## Download

61
README_TESTERS.md Normal file
View File

@ -0,0 +1,61 @@
# Hello Ghostty Testers! 👋👻
Thank you for being an early Ghostty user! I'm super excited to have you
here. **Please, please read the [README](https://github.com/mitchellh/ghostty#readme)!**
There is a lot of information in the README that I will not be repeating here,
especially about how to get Ghostty and configure it.
## Let's Build An Excellent Terminal
The Ghostty development process so far has been a cycle of inviting people,
getting Ghostty to work great for them, then inviting new people once it
feels stable.
So, if you're part of a new group, _expect there will be bugs_!
Ghostty may work really great for previous testers, but every new group of
users has their own OS quirks, programs, expected features, etc. that tend
to surface new issues. **That's why you're here and I appreciate you so much!**
**I will not invite new groups of testers until Ghostty is _very stable and
excellent_ for the previous group of testers.** So let's work together on getting
Ghostty to a place that works well for you.
## Talking About Ghostty Publicly
Feel free to talk about Ghostty, share screenshots, etc. in the public!
Please don't share source access yet. And obviously, if Ghostty is buggy
or you want to say something mean, I'd rather you talk to me first so
I can try to fix it, this is an early beta after all... I hope no testers
I invite would be mean, though!
## Reporting Issues and Contributing
Please report any issues you have, including feature requests! Because we're
in a closed beta period, there aren't really many rules -- just open 'em up
and we'll have a discussion.
That said, **feel free to contribute!** I would _love_ that. If you want
any help, ask in Discord and I'll do my best to point you in the right direction
or even pair (time permitting) if you're interested.
### Bug Priority
This is the priority of bugs:
1. Crashes. 💥 These are just unacceptable and I'll drop everything to
fix a crash.
2. Escape sequence logic or rendering issues. These are almost as bad as
crashes because they usually make your workflow unusable. This includes
unsupported escape sequences that impact your workflow.
3. Anything else...
## Let's Talk!
By being invited to the project, you also should've been invited to the
Discord community. If you haven't, please open an issue and I'll post
an expiring invite link.
**The Discord community is private, for now.** Please don't invite friends,
yet! I want to keep it limited to testers.

View File

@ -1,5 +1,9 @@
# Control and Escape Sequences
⚠️ **This is super out of date. Ghostty's support is much better
than this document seems. TODO to update this.** ⚠️
This is the list of control and escape sequences known in the ecosystem
of terminal emulators and their implementation status in ghostty. Note that
some control sequences may never be implemented in ghostty. In these scenarios,