Skip to content

Commit 57f7a7f

Browse files
author
psadi
committed
docs: add graphical auto instructions
closes #59
1 parent b87d9ba commit 57f7a7f

File tree

3 files changed

+67
-24
lines changed

3 files changed

+67
-24
lines changed

.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
workflow_dispatch: {}
1010
pull_request:
1111
paths-ignore:
12-
- "**/README.md"
12+
- "**/*.md"
1313
- "**/VERSION"
1414
types: [opened, synchronize, reopened]
1515
release:

README.md

Lines changed: 46 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ This repository provides build scripts to create a Universal AppImage for [Ghost
3333

3434
## ⚙️ Installation
3535

36-
### Command Line (Manual)
36+
<details>
37+
<summary><b>Command Line (Manual)</b></summary>
3738

3839
Run the following commands in your terminal:
3940

@@ -59,7 +60,10 @@ install ./Ghostty-${VERSION}-${ARCH}.AppImage $HOME/.local/bin/ghostty
5960
ghostty
6061
```
6162

62-
### Command Line (Auto)
63+
</details>
64+
65+
<details>
66+
<summary><b>Command Line (Automatic)</b></summary>
6367

6468
Ghostty AppImage can be accessed through [**Soar**](https://github.com/pkgforge/soar) or [**AM**](https://github.com/ivan-hc/AM)/[**AppMan**](https://github.com/ivan-hc/AppMan). These tools automate the installation process, configure the PATH, and integrate with your desktop environment when installing AppImages.
6569

@@ -91,7 +95,10 @@ Ghostty AppImage can be accessed through [**Soar**](https://github.com/pkgforge/
9195

9296
_Note: Ensure you have the necessary permissions to run these commands. For more detailed usage, refer to the documentation of each tool._
9397

94-
### Graphical
98+
</details>
99+
100+
<details>
101+
<summary><b>Graphical (Manual)</b></summary>
95102

96103
1. Download the latest AppImage package from the [releases](https://github.com/psadi/ghostty-appimage/releases) section.
97104
2. Locate the downloaded file in your file explorer (e.g., Nautilus, Thunar, PCManFM).
@@ -104,40 +111,56 @@ _Note: Ensure you have the necessary permissions to run these commands. For more
104111
<img src="./assets/2.png" alt="Step 2" width="384">
105112
</p>
106113

107-
## ⏫ Updating
114+
</details>
108115

109-
Since AppImages are self-contained executables, there is no formal installation process beyond setting executable permissions.
116+
<details>
117+
<summary><b>Graphical (Automatic)</b></summary>
110118

111-
**Update manually:**
119+
Ghostty AppImage can easily be managed using graphical tools such as [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) and [Gear Lever](https://github.com/mijorus/gearlever).
112120

113-
1. Download the latest AppImage package from the [releases](https://github.com/psadi/ghostty-appimage/releases) section.
114-
1. Follow the same steps as in the [Installation](#installation) section to make it executable and run it.
121+
1. **Using [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher)**
115122

116-
**Update automatically:**
123+
For detailed instructions, please refer to the [AppImageLauncher documentation](https://docs.appimage.org/user-guide/run-appimages.html#appimagelauncher).
117124

118-
1. Use [AppImageUpdate](https://github.com/AppImageCommunity/AppImageUpdate) which reads the update information in the AppImage. This is a low level tool.
119-
1. Use a higher level tool that uses AppImageUpdate, like [Soar](https://github.com/pkgforge/soar), [AM](https://github.com/ivan-hc/AM) or [appimaged](https://github.com/probonopd/go-appimage/blob/master/src/appimaged/README.md) daemon, these tools also automatically handle desktop integration.
125+
> **🛈 NOTE**
126+
>
127+
> With the launch of AppImageLauncher **v3.0.0**, you have to use the alpha pre-releases as the stable release doesn't work with the static runtime
128+
>
129+
> For more information please refer the [discussion](https://github.com/TheAssassin/AppImageLauncher/discussions/687) and the [comment](https://github.com/TheAssassin/AppImageLauncher/discussions/687#discussioncomment-12181060)
120130
121-
## 🛠️ Troubleshooting
131+
2. **Using [Gear Lever](https://github.com/mijorus/gearlever)**
122132

123-
**Known Issues**
133+
- Download the latest AppImage package from the [releases](https://github.com/psadi/ghostty-appimage/releases) section.
134+
- Simply drag and drop the files from your file manager into the Gear Lever application.
135+
- Follow the on-screen instructions to configure the setup as a one-time installation process.
124136

125-
1. **[TERMINFO](https://ghostty.org/docs/help/terminfo) `xterm-ghostty` not-set/breaks functionality**
137+
_Note: Ensure the necessary prerequsites are satisfied for these applications. For more detailed usage, refer to the documentation of each tool_
126138

127-
**Fix:** Set the TERMINFO value to `xterm-256color` at runtime by running the AppImage as follows,
139+
</details>
128140

129-
```bash
130-
# Option 1
131-
❯ TERM=xterm-256color ./Ghostty-${VERSION}-${ARCH}.AppImage
141+
## ⏫ Updating
132142

133-
# Option 2: Add `export TERM=xterm-256color` to your .bashrc or .zshrc and launch the appimage normally
134-
```
143+
Since AppImages are self-contained executables, there is no formal installation process beyond setting executable permissions.
144+
145+
<details>
146+
<summary><b>Update (Manual)</b></summary>
147+
148+
1. Download the latest AppImage package from the [releases](https://github.com/psadi/ghostty-appimage/releases) section.
149+
1. Follow the same steps as in the [Installation](#installation) section to make it executable and run it.
135150

136-
1. **Gtk-CRITICAL \*\*: 13:43:27.628: gtk_widget_unparent: assertion 'GTK_IS_WIDGET (widget)' failed**
151+
</details>
137152

138-
**Fix:** Referenced in [#3267](https://github.com/ghostty-org/ghostty/discussions/3267), reported/resolved at [#32](https://github.com/psadi/ghostty-appimage/issues/32)
153+
<details>
154+
<summary><b>Update (Automatic)</b></summary>
155+
156+
1. Use [AppImageUpdate](https://github.com/AppImageCommunity/AppImageUpdate) which reads the update information in the AppImage. This is a low level tool.
157+
1. Use a higher level tool that uses AppImageUpdate, like [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher), [AM](https://github.com/ivan-hc/AM) or [appimaged](https://github.com/probonopd/go-appimage/blob/master/src/appimaged/README.md) daemon, these tools also automatically handle desktop integration.
158+
159+
</details>
160+
161+
## 🛠️ Troubleshooting
139162

140-
_If you encounter any errors, check the terminal for error messages that may indicate missing dependencies or other issues_
163+
Refer [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) file
141164

142165
## 🤝 Contributing
143166

TROUBLESHOOTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## 🛠️ Troubleshooting
2+
3+
**Known Issues**
4+
5+
1. **[TERMINFO](https://ghostty.org/docs/help/terminfo) `xterm-ghostty` not-set/breaks functionality**
6+
7+
**Fix:** Set the TERMINFO value to `xterm-256color` at runtime by running the AppImage as follows,
8+
9+
```bash
10+
# Option 1
11+
❯ TERM=xterm-256color ./Ghostty-${VERSION}-${ARCH}.AppImage
12+
13+
# Option 2: Add `export TERM=xterm-256color` to your .bashrc or .zshrc and launch the appimage normally
14+
```
15+
16+
1. **Gtk-CRITICAL \*\*: 13:43:27.628: gtk_widget_unparent: assertion 'GTK_IS_WIDGET (widget)' failed**
17+
18+
**Fix:** Referenced in [#3267](https://github.com/ghostty-org/ghostty/discussions/3267), reported/resolved at [#32](https://github.com/psadi/ghostty-appimage/issues/32)
19+
20+
_If you encounter any errors, check the terminal for error messages that may indicate missing dependencies or other issues_

0 commit comments

Comments
 (0)