Skip to content

Commit 94d308c

Browse files
committed
Expand and reorder README
1 parent 6f143c2 commit 94d308c

1 file changed

Lines changed: 123 additions & 64 deletions

File tree

README.md

Lines changed: 123 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is an **up-to-date** fork of [GitHub Desktop](https://desktop.github.com) w
55
> [!IMPORTANT]
66
> This is a community-maintained project. It **is not** an official GitHub product.
77
8-
## Highlights
8+
## Highlights 👀
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) |
@@ -14,60 +14,136 @@ This is an **up-to-date** fork of [GitHub Desktop](https://desktop.github.com) w
1414
| <h4>Indicator for missing branches in the remote</h4> | <h4>Indicator for merge commits</h4> |
1515
| ![Push indicator](docs/assets/github-desktop-plus-demo-push-indicator.webp) | ![Merge commits](docs/assets/github-desktop-plus-demo-merge-commits.webp) |
1616

17-
<img src="docs/assets/github-desktop-plus-demo.webp" alt="Demo" style="max-width:1000px;">
1817

19-
## Additional Features in GitHub Desktop Plus
18+
## Additional Features in GitHub Desktop Plus ✨
19+
20+
<details>
21+
<summary>Click to expand list</summary>
2022

2123
### General:
2224

23-
- Experimental support for **multiple accounts** of the same endpoint (e.g. multiple GitHub accounts).
24-
- Support for **Git Worktrees**: view and manage all your worktrees in the same repository, with the ability to easily switch between them.
25+
- Support for **multiple accounts** of the same endpoint (e.g. multiple GitHub accounts).
26+
Simply add as many accounts as you want in the "Accounts" settings page. If a repository is using an incorrect account, you can change it in the repository settings.
27+
28+
- Support for **Git Worktrees**: view and manage all your worktrees in the same repository, with the ability to easily switch between them.
29+
To view the worktrees dropdown, enable it in the app settings or press `Ctrl+E` / `Cmd+E`.
30+
31+
- Support for **multiple windows**: open multiple repositories in separate windows, or the same repository in multiple windows (e.g. to view different files at the same time).
32+
Select "File" > "Open new window" or press `Ctrl+Alt+N`/`Cmd+Alt+N`. You can also right-click on a repository in the list and select "Open repository in new window".
33+
2534
- **Bitbucket** and **GitLab** integration:
2635
- Clone repositories from within the app.
2736
- Preview and create pull requests.
2837
- View pull requests status, including checks.
2938
- Display a commit or PR in Bitbucket/GitLab (web browser).
3039
- Correctly set repository owner (instead of displaying "Other").
40+
41+
The integration is enabled automatically for the corresponding repositories if you are logged in to your account.
42+
3143
- Allow using a **different text editor for a given repo**, by overriding it in the repository settings.
32-
- Add **icons** to some similar-looking buttons for faster visual recognition.
33-
- Red background for destructive action buttons.
34-
- Allow generating **branch name presets** by calling an external script (e.g. fetching ticket numbers from an issue tracker). [Click here for more details](docs/branch-name-presets.md).
44+
45+
- Some similar-looking buttons now have distinct **icons** for faster visual recognition.
46+
47+
- Buttons with destructive actions have a red background to make them more visually distinct.
48+
49+
- Allow generating **branch name presets** by calling an external script (e.g. fetching ticket numbers from an issue tracker).
50+
[Click here for more details](docs/branch-name-presets.md).
3551

3652
### Repositories list:
3753

3854
- "**Pull all**" button to fetch and pull all your repositories at once.
55+
3956
- Allow showing the **current branch name** next to the repository name.
40-
- Allow **hiding** the "**Recent**" repositories section.
41-
- Allow customizing the **repository groups** to better organize your repositories (right click on a repository and select "Change group name").
57+
58+
- Allow **hiding** the "Recent" repositories section.
59+
60+
- Allow customizing the **repository groups** to better organize your repositories.
61+
Right click on a repository and select "Change group name".
4262

4363
### Branches list:
4464

45-
- Add warning indicator to **local-only branches** (branches that have not been pushed to the remote, or that have been deleted automatically after a PR).
46-
- Allow manually setting which is the **default branch** for a repository (even if it doesn't match the one configured in the remote).
65+
- Added a warning indicator to **local-only branches** (branches that have not been pushed to the remote, or that have been deleted automatically after a PR).
66+
67+
- Allow manually setting which is the **default branch** for a repository (even if it doesn't match the one configured in the remote).
68+
Right click on a branch and select "Set as default branch". The default branch is used as the base when creating new branches.
69+
70+
- Allow changing the **sort order** of the branch list to either "Recently updated" or "Alphabetical".
4771

4872
### History tab:
4973

5074
- **Search commits** by title, message, tag, or hash.
75+
5176
- Use a different font style for **merge commits** in order to make them visually distinct, since most of the time they are not as relevant.
77+
78+
- Allow choosing between relative dates ("3 days ago") or absolute dates ("Mar 14, 2026, 2:34 PM") for displaying commit dates.
79+
5280
- If a commit modifies only 1 file, allow double-clicking the commit to open the file. For other commits, you can still double-click the file as usual.
81+
5382
- Allow deleting commits and tags that have already been pushed. Please note that this is intended for advanced users only, and can cause problems if the commits have already been pulled by other collaborators.
5483

5584
### Changes tab:
5685

57-
- Context menu option to **permanently discard changes** without sending to trash (useful when the there are many changed files and the regular "Discard" is extremely slow).
86+
- Added the option to **permanently discard changes** without sending to trash. This is useful when the there are many changed files and the regular "Discard" is extremely slow.
5887

59-
## Download and Installation
88+
---
6089

61-
### Arch Linux / Manjaro (AUR)
90+
<img src="docs/assets/github-desktop-plus-demo.webp" alt="Demo" style="max-width:1000px;">
91+
92+
</details>
93+
94+
## Download and Installation 📦
95+
96+
### Windows
6297

6398
<details>
6499
<summary>Click to expand</summary>
65100

66-
Simply install `github-desktop-plus-bin` from the AUR.
101+
#### Using Winget (Recommended)
67102

68-
You can also build from source by installing `github-desktop-plus` or `github-desktop-plus-git` from the AUR.
103+
```powershell
104+
winget install polrivero.GitHubDesktopPlus
105+
```
69106

70-
> `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.
107+
To update, run `winget upgrade polrivero.GitHubDesktopPlus` or `winget upgrade --all` to update all your winget packages. Make sure to update regularly to get the latest features and fixes.
108+
109+
#### Manual download (Not recommended)
110+
111+
Download and execute the installer from the [releases page](https://github.com/pol-rivero/github-desktop-plus/releases/latest).
112+
113+
| | **64-bit x86** | **64-bit ARM** |
114+
| --- | --- | --- |
115+
| **.EXE Installer** | `-win-x64.exe` | `-win-arm64.exe` |
116+
| **.MSI Installer** | `-win-x64.msi` | `-win-arm64.msi` |
117+
118+
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.
119+
For this reason, I recommend using Winget instead of the manual download.
120+
121+
</details>
122+
123+
### macOS
124+
125+
<details>
126+
<summary>Click to expand</summary>
127+
128+
#### Using Homebrew (Recommended)
129+
130+
```bash
131+
brew install pol-rivero/tap/github-desktop-plus
132+
```
133+
134+
Make sure to run `brew update` regularly to get the latest updates for GitHub Desktop Plus.
135+
136+
#### Manual download (Not recommended)
137+
138+
Download and extract the ZIP file from the [releases page](https://github.com/pol-rivero/github-desktop-plus/releases/latest). Click the app file to run it.
139+
If you encounter the error "Apple could not verify this app is free of malware", go to "System Settings" > "Privacy & Security", scroll down to "Security" and click "Open Anyway" on "GitHub Desktop Plus".
140+
141+
| **64-bit x86** | **64-bit ARM (Apple Silicon)** |
142+
| --- | --- |
143+
| `-macOS-x64.zip` | `-macOS-arm64.zip` |
144+
145+
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.
146+
For this reason, I recommend using Homebrew instead of the manual download.
71147

72148
</details>
73149

@@ -114,91 +190,74 @@ sudo dnf install github-desktop-plus
114190

115191
</details>
116192

117-
118-
### Flatpak (any distro)
193+
### Arch Linux / Manjaro (AUR)
119194

120195
<details>
121196
<summary>Click to expand</summary>
122197

123-
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:
198+
Simply install `github-desktop-plus-bin` from the AUR.
124199

125-
```bash
126-
flatpak install flathub io.github.pol_rivero.github-desktop-plus
127-
```
200+
You can also build from source by installing `github-desktop-plus` or `github-desktop-plus-git` from the AUR.
201+
202+
> `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.
128203
129204
</details>
130205

131-
### AppImage (any distro, not recommended)
206+
207+
### Flatpak (any distro)
132208

133209
<details>
134210
<summary>Click to expand</summary>
135211

136-
Download the AppImage from the [releases page](https://github.com/pol-rivero/github-desktop-plus/releases/latest) and make it executable:
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:
137213

138214
```bash
139-
chmod +x GitHub-Desktop-Plus-*-linux-*.AppImage
140-
# Just double-click the file to run it
215+
flatpak install flathub io.github.pol_rivero.github-desktop-plus
141216
```
142217

143-
| **64-bit x86** | **64-bit ARM** |
144-
| --- | --- |
145-
| `-linux-x86_64.AppImage` | `-linux-arm64.AppImage` |
146-
147218
</details>
148219

149-
### Windows
220+
### AppImage (any distro)
150221

151222
<details>
152223
<summary>Click to expand</summary>
153224

154-
#### Using Winget (Recommended)
225+
> [!NOTE]
226+
> I recommend using your distribution's native package manager (or Flatpak) instead of the AppImage.
155227
156-
```powershell
157-
winget install polrivero.GitHubDesktopPlus
158-
```
228+
#### Using ["AM"/"AppMan"](https://github.com/ivan-hc/AM)
159229

160-
To update, run `winget upgrade polrivero.GitHubDesktopPlus` or `winget upgrade --all` to update all your winget packages. Make sure to update regularly to get the latest features and fixes.
230+
```bash
231+
# If using "AM":
232+
am install github-desktop-plus
233+
# If using "AppMan":
234+
appman install github-desktop-plus
235+
```
161236

162237
#### Manual download (Not recommended)
163238

164-
Download and execute the installer from the [releases page](https://github.com/pol-rivero/github-desktop-plus/releases/latest).
165-
166-
| | **64-bit x86** | **64-bit ARM** |
167-
| --- | --- | --- |
168-
| **.EXE Installer** | `-win-x64.exe` | `-win-arm64.exe` |
169-
| **.MSI Installer** | `-win-x64.msi` | `-win-arm64.msi` |
170-
171-
</details>
172-
173-
### macOS
239+
Download the AppImage from the [releases page](https://github.com/pol-rivero/github-desktop-plus/releases/latest):
174240

175-
<details>
176-
<summary>Click to expand</summary>
241+
| **64-bit x86** | **64-bit ARM** |
242+
| --- | --- |
243+
| `-linux-x86_64.AppImage` | `-linux-arm64.AppImage` |
177244

178-
#### Using Homebrew (Recommended)
245+
Then, make it executable:
179246

180247
```bash
181-
brew install pol-rivero/tap/github-desktop-plus
248+
chmod +x GitHub-Desktop-Plus-*-linux-*.AppImage
182249
```
183250

184-
Make sure to run `brew update` regularly to get the latest updates for GitHub Desktop Plus.
251+
Finally, double-click the .AppImage file to run it.
185252

186-
#### Manual download (Not recommended)
187-
188-
Download and extract the ZIP file from the [releases page](https://github.com/pol-rivero/github-desktop-plus/releases/latest). Click the app file to run it.
189-
If you encounter the error "Apple could not verify this app is free of malware", go to "System Settings" > "Privacy & Security", scroll down to "Security" and click "Open Anyway" on "GitHub Desktop Plus".
190-
191-
| **64-bit x86** | **64-bit ARM (Apple Silicon)** |
192-
| --- | --- |
193-
| `-macOS-x64.zip` | `-macOS-arm64.zip` |
194253

195254
</details>
196255

197-
## Common issues
256+
## Common issues 🛠️
198257

199258
Before opening a new issue, please check the [Known Issues](docs/known-issues.md) document for common issues and their workarounds.
200259

201-
## Running the app locally
260+
## Running the app locally 💻
202261

203262
### From the terminal
204263

@@ -241,7 +300,7 @@ yarn test:docker
241300

242301
## Why this fork?
243302

244-
First of all, because shiftkey's fork is currently unmaintained (last commit was in February 2025), so it's not getting the latest features and fixes from the official GitHub Desktop repository.
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.
245304

246305
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.
247306
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.

0 commit comments

Comments
 (0)