Skip to content

Commit 83d3dd7

Browse files
committed
Expand and reorder README
1 parent 94d308c commit 83d3dd7

2 files changed

Lines changed: 30 additions & 9 deletions

File tree

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ This is an **up-to-date** fork of [GitHub Desktop](https://desktop.github.com) w
99
| <h4>Search commits by title, message, tag, or hash</h4> | <h4>Add multiple GitHub, Bitbucket & GitLab accounts</h4> |
1010
| :---: | :---: |
1111
| ![Commit search](docs/assets/github-desktop-plus-demo-search.webp) | ![Multiple accounts](docs/assets/github-desktop-plus-demo-multiaccount.webp) |
12-
| <h4>Create multiple stashes per branch</h4> | <h4>Buttons optimized for visual recognition</h4> |
13-
| ![Multiple stashes](docs/assets/github-desktop-plus-demo-stashes.webp) | ![Stash header](docs/assets/github-desktop-plus-demo-stash-header.webp) |
14-
| <h4>Indicator for missing branches in the remote</h4> | <h4>Indicator for merge commits</h4> |
15-
| ![Push indicator](docs/assets/github-desktop-plus-demo-push-indicator.webp) | ![Merge commits](docs/assets/github-desktop-plus-demo-merge-commits.webp) |
12+
| <h4>Create multiple stashes per branch</h4> | <h4>Native support for Git Worktrees</h4> |
13+
| ![Multiple stashes](docs/assets/github-desktop-plus-demo-stashes.webp) | ![Worktrees](docs/assets/github-desktop-plus-demo-worktrees.webp) |
14+
| <h4>Buttons optimized for visual recognition</h4> | <h4>Quickly find unpushed branches</h4> |
15+
| ![Stash header](docs/assets/github-desktop-plus-demo-stash-header.webp) | ![Branch push indicator](docs/assets/github-desktop-plus-demo-push-indicator.webp) |
1616

1717

1818
## Additional Features in GitHub Desktop Plus ✨
@@ -118,6 +118,8 @@ Download and execute the installer from the [releases page](https://github.com/p
118118
Please note that the app doesn't autoupdate like the official GitHub Desktop, so you will need to manually download and install it every time you want to update.
119119
For this reason, I recommend using Winget instead of the manual download.
120120

121+
---
122+
121123
</details>
122124

123125
### macOS
@@ -145,13 +147,16 @@ If you encounter the error "Apple could not verify this app is free of malware",
145147
Please note that the app doesn't autoupdate like the official GitHub Desktop, so you will need to manually download it every time you want to update.
146148
For this reason, I recommend using Homebrew instead of the manual download.
147149

150+
---
151+
148152
</details>
149153

150154
### Debian / Ubuntu / Linux Mint / Pop!_OS / Zorin OS (APT)
151155

152156
<details>
153157

154158
<summary>Click to expand</summary>
159+
<br>
155160

156161
Create the repository file:
157162

@@ -166,13 +171,16 @@ sudo apt update
166171
sudo apt install github-desktop-plus
167172
```
168173

174+
---
175+
169176
</details>
170177

171178

172179
### Fedora / RHEL / CentOS (RPM)
173180

174181
<details>
175182
<summary>Click to expand</summary>
183+
<br>
176184

177185
Create the repository file:
178186

@@ -188,42 +196,54 @@ sudo dnf check-update
188196
sudo dnf install github-desktop-plus
189197
```
190198

199+
---
200+
191201
</details>
192202

193203
### Arch Linux / Manjaro (AUR)
194204

195205
<details>
196206
<summary>Click to expand</summary>
207+
<br>
197208

198-
Simply install `github-desktop-plus-bin` from the AUR.
209+
Simply install `github-desktop-plus-bin` from the AUR using your preferred AUR helper.
210+
211+
```sh
212+
yay -S github-desktop-plus-bin
213+
```
199214

200215
You can also build from source by installing `github-desktop-plus` or `github-desktop-plus-git` from the AUR.
201216

202217
> `gnome-keyring` is required and the daemon must be launched either at login or when the X server / Wayland compositor is started. Normally this is handled by a display manager, but in other cases following the instructions found on the [Arch Wiki](https://wiki.archlinux.org/index.php/GNOME/Keyring#Using_the_keyring_outside_GNOME) will fix the issue of not being able to save login credentials.
203218
219+
---
220+
204221
</details>
205222

206223

207224
### Flatpak (any distro)
208225

209226
<details>
210227
<summary>Click to expand</summary>
228+
<br>
211229

212-
You can install GitHub Desktop Plus from Flathub by following the instructions at https://flathub.org/en/apps/io.github.pol_rivero.github-desktop-plus or by running the following command:
230+
Simply install GitHub Desktop Plus from [Flathub](https://flathub.org/en/apps/io.github.pol_rivero.github-desktop-plus):
213231

214232
```bash
215233
flatpak install flathub io.github.pol_rivero.github-desktop-plus
216234
```
217235

236+
---
237+
218238
</details>
219239

220240
### AppImage (any distro)
221241

222242
<details>
223243
<summary>Click to expand</summary>
244+
<br>
224245

225-
> [!NOTE]
226-
> I recommend using your distribution's native package manager (or Flatpak) instead of the AppImage.
246+
**NOTE:** I recommend using your distribution's native package manager (or Flatpak) instead of the AppImage.
227247

228248
#### Using ["AM"/"AppMan"](https://github.com/ivan-hc/AM)
229249

@@ -250,6 +270,7 @@ chmod +x GitHub-Desktop-Plus-*-linux-*.AppImage
250270

251271
Finally, double-click the .AppImage file to run it.
252272

273+
---
253274

254275
</details>
255276

@@ -300,7 +321,7 @@ yarn test:docker
300321

301322
## Why this fork?
302323

303-
First of all, because shiftkey's fork is currently unmaintained (last commit was in February 2025), so all Linux users are no longer getting the latest features and fixes from the official GitHub Desktop repository.
324+
First of all, because [shiftkey's fork](https://github.com/shiftkey/desktop) is currently unmaintained (last commit was in February 2025), so all Linux users are no longer getting the latest features and fixes from the official GitHub Desktop repository.
304325

305326
Secondly, I think the official GitHub Desktop app is very slow in terms of updates and lacks some advanced features that I'd like. This fork has low code quality requirements compared to the official repo, so I (and hopefully you as well) can add features and improvements quickly.
306327
This fork also focuses on integrating nicely with Bitbucket, since I use it for work and haven't found a good Linux GUI client for it.
14.4 KB
Loading

0 commit comments

Comments
 (0)