Skip to content

Commit a6c6ea1

Browse files
pol-riveropol-rivero
committed
Update readme
- Remove outdated readme from the shiftkey fork (previously hidden in <details>) - Update Ubuntu install instructions to avoid a misleading error message - Update APT distro list
1 parent 0eed4ef commit a6c6ea1

File tree

1 file changed

+4
-185
lines changed

1 file changed

+4
-185
lines changed

‎README.md‎

Lines changed: 4 additions & 185 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GitHub Desktop Plus
22

3-
This is an **up-to-date** fork of [GitHub Desktop](https://desktop.github.com) for Linux with additional features and improvements.
3+
This is an **up-to-date** fork of [GitHub Desktop](https://desktop.github.com) with additional features and improvements.
44

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

@@ -62,7 +62,7 @@ You can also build from source by installing `github-desktop-plus` or `github-de
6262
6363
</details>
6464

65-
### Debian / Ubuntu (APT)
65+
### Debian / Ubuntu / Linux Mint / Pop!_OS / Zorin OS (APT)
6666

6767
<details>
6868

@@ -71,7 +71,7 @@ You can also build from source by installing `github-desktop-plus` or `github-de
7171
Create the repository file:
7272

7373
```bash
74-
curl https://gpg.polrivero.com/public.key | sudo gpg --dearmor -o /usr/share/keyrings/polrivero.gpg
74+
sudo curl https://gpg.polrivero.com/public.key | sudo gpg --dearmor -o /usr/share/keyrings/polrivero.gpg
7575
echo "deb [signed-by=/usr/share/keyrings/polrivero.gpg] https://deb.github-desktop.polrivero.com/ stable main" | sudo tee /etc/apt/sources.list.d/github-desktop-plus.list
7676
```
7777

@@ -119,7 +119,7 @@ flatpak install flathub io.github.pol_rivero.github-desktop-plus
119119

120120
</details>
121121

122-
### AppImage (any distro)
122+
### AppImage (any distro, not recommended)
123123

124124
<details>
125125
<summary>Click to expand</summary>
@@ -214,184 +214,3 @@ Secondly, I think the official GitHub Desktop app is very slow in terms of updat
214214
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.
215215

216216
Keep in mind that this version is not endorsed by GitHub, and it's aimed at power users with technical knowledge. If you're looking for a polished and stable product, I recommend using the official GitHub Desktop app instead.
217-
218-
---
219-
220-
<details>
221-
<summary>See original README</summary>
222-
223-
# [GitHub Desktop](https://desktop.github.com) - The Linux Fork
224-
225-
[![CI](https://github.com/shiftkey/desktop/actions/workflows/ci.yml/badge.svg)](https://github.com/shiftkey/desktop/actions/workflows/ci.yml)
226-
227-
[GitHub Desktop](https://desktop.github.com/) is an open-source [Electron](https://www.electronjs.org/)-based
228-
GitHub app. It is written in [TypeScript](https://www.typescriptlang.org) and
229-
uses [React](https://reactjs.org/).
230-
231-
<picture>
232-
<source
233-
srcset="https://user-images.githubusercontent.com/634063/202742848-63fa1488-6254-49b5-af7c-96a6b50ea8af.png"
234-
media="(prefers-color-scheme: dark)"
235-
/>
236-
<img
237-
width="1072"
238-
src="https://user-images.githubusercontent.com/634063/202742985-bb3b3b94-8aca-404a-8d8a-fd6a6f030672.png"
239-
alt="A screenshot of the GitHub Desktop application showing changes being viewed and committed with two attributed co-authors"
240-
/>
241-
</picture>
242-
243-
## What is this repository for?
244-
245-
This repository contains specific patches on top of the upstream
246-
`desktop/desktop` repository to support Linux usage.
247-
248-
It also publishes [releases](https://github.com/shiftkey/desktop/releases) for various Linux distributions:
249-
250-
- AppImage (`.AppImage`)
251-
- Debian (`.deb`)
252-
- RPM (`.rpm`)
253-
254-
## Installation via package manager
255-
256-
You can use your operating system's package manager to install `github-desktop` and
257-
keep it up to date on Debian and RPM-based distributions.
258-
259-
### Debian/Ubuntu
260-
261-
There are two APT package feeds available, both hosted in the US. You only need
262-
to add one or the other here, as both of these are generated based on the
263-
releases from this repository.
264-
265-
#### [@shiftkey](https://github.com/shiftkey) package feed
266-
267-
```sh
268-
wget -qO - https://apt.packages.shiftkey.dev/gpg.key | gpg --dearmor | sudo tee /usr/share/keyrings/shiftkey-packages.gpg > /dev/null
269-
sudo sh -c 'echo "deb [arch=amd64 signed-by=/usr/share/keyrings/shiftkey-packages.gpg] https://apt.packages.shiftkey.dev/ubuntu/ any main" > /etc/apt/sources.list.d/shiftkey-packages.list'
270-
```
271-
272-
#### [@mwt](https://github.com/mwt) package feed
273-
274-
```sh
275-
wget -qO - https://mirror.mwt.me/shiftkey-desktop/gpgkey | gpg --dearmor | sudo tee /usr/share/keyrings/mwt-desktop.gpg > /dev/null
276-
sudo sh -c 'echo "deb [arch=amd64 signed-by=/usr/share/keyrings/mwt-desktop.gpg] https://mirror.mwt.me/shiftkey-desktop/deb/ any main" > /etc/apt/sources.list.d/mwt-desktop.list'
277-
```
278-
279-
#### Installation
280-
281-
Once you have a feed configured, run this command to install the application:
282-
283-
```sh
284-
sudo apt update && sudo apt install github-desktop
285-
```
286-
287-
### Red Hat/CentOS/Fedora
288-
289-
There are two RPM package feeds available, both hosted in the US. You only need
290-
to add one or the other here, as both of these are generated based on the
291-
releases from this repository.
292-
293-
#### [@shiftkey](https://github.com/shiftkey) package feed
294-
295-
```sh
296-
sudo rpm --import https://rpm.packages.shiftkey.dev/gpg.key
297-
sudo sh -c 'echo -e "[shiftkey-packages]\nname=GitHub Desktop\nbaseurl=https://rpm.packages.shiftkey.dev/rpm/\nenabled=1\ngpgcheck=1\nrepo_gpgcheck=1\ngpgkey=https://rpm.packages.shiftkey.dev/gpg.key" > /etc/yum.repos.d/shiftkey-packages.repo'
298-
```
299-
300-
#### [@mwt](https://github.com/mwt) package feed
301-
302-
```sh
303-
sudo rpm --import https://mirror.mwt.me/shiftkey-desktop/gpgkey
304-
sudo sh -c 'echo -e "[mwt-packages]\nname=GitHub Desktop\nbaseurl=https://mirror.mwt.me/shiftkey-desktop/rpm\nenabled=1\ngpgcheck=1\nrepo_gpgcheck=1\ngpgkey=https://mirror.mwt.me/shiftkey-desktop/gpgkey" > /etc/yum.repos.d/mwt-packages.repo'
305-
```
306-
307-
#### Installation
308-
309-
Once you have a feed configured, run this command to install the application:
310-
311-
```sh
312-
# if yum is your package manager
313-
sudo yum install github-desktop
314-
315-
# if dnf is your package manager
316-
sudo dnf install github-desktop
317-
318-
# if zypper is your package manager
319-
sudo zypper ref && sudo zypper in github-desktop
320-
```
321-
322-
#### OpenSUSE
323-
324-
There are two RPM package feeds available, both hosted in the US. You only need
325-
to add one or the other here, as both of these are generated based on the
326-
releases from this repository.
327-
328-
#### [@shiftkey](https://github.com/shiftkey) package feed
329-
330-
```sh
331-
sudo rpm --import https://rpm.packages.shiftkey.dev/gpg.key
332-
sudo sh -c 'echo -e "[shiftkey-packages]\nname=GitHub Desktop\nbaseurl=https://rpm.packages.shiftkey.dev/rpm/\nenabled=1\ngpgcheck=1\nrepo_gpgcheck=1\ngpgkey=https://rpm.packages.shiftkey.dev/gpg.key" > /etc/zypp/repos.d/shiftkey-packages.repo'
333-
```
334-
335-
#### [@mwt](https://github.com/mwt) package feed
336-
337-
```sh
338-
sudo rpm --import https://mirror.mwt.me/shiftkey-desktop/gpgkey
339-
sudo sh -c 'echo -e "[mwt-packages]\nname=GitHub Desktop\nbaseurl=https://mirror.mwt.me/shiftkey-desktop/rpm\nenabled=1\ngpgcheck=1\nrepo_gpgcheck=1\ngpgkey=https://mirror.mwt.me/shiftkey-desktop/gpgkey" > /etc/zypp/repos.d/mwt-packages.repo'
340-
```
341-
342-
#### Installation
343-
344-
```sh
345-
sudo zypper ref && sudo zypper in github-desktop
346-
```
347-
348-
349-
## Other Distributions
350-
351-
### Arch Linux
352-
353-
Arch Linux users can install GitHub Desktop from the [AUR](https://aur.archlinux.org/packages/github-desktop-bin/).
354-
355-
`gnome-keyring` is required and the daemon must be launched either at login or when the X server 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.
356-
357-
### Cross-Distribution Packages
358-
359-
GitHub Desktop is also available cross-platform as a [Flatpak](https://github.com/flathub/io.github.shiftey.Desktop) and [AppImage](https://appimage.github.io/GitHubDesktop/).
360-
361-
### deb-get
362-
363-
Debian/Ubuntu users can also install directly from this repository using [`deb-get`](https://github.com/wimpysworld/deb-get): `deb-get install github-desktop`.
364-
365-
## Known issues
366-
367-
If you're having troubles with Desktop, please refer to the [Known issues](docs/known-issues.md#linux)
368-
document for guidance and workarounds for common limitations.
369-
370-
If your package manager is still trying to reach PackageCloud, refer to the
371-
[cleanup instructions](docs/known-issues.md#the-packagecloud-package-feed-is-no-longer-working)
372-
for details about migrating away.
373-
374-
## More information
375-
376-
Please check out the [README](https://github.com/desktop/desktop#github-desktop)
377-
on the upstream [GitHub Desktop project](https://github.com/desktop/desktop) and
378-
[desktop.github.com](https://desktop.github.com) for more product-oriented
379-
information about GitHub Desktop.
380-
381-
See our [getting started documentation](https://docs.github.com/en/desktop/overview/getting-started-with-github-desktop) for more information on how to set up, authenticate, and configure GitHub Desktop.
382-
383-
## License
384-
385-
**[MIT](LICENSE)**
386-
387-
The MIT license grant is not for GitHub's trademarks, which include the logo
388-
designs. GitHub reserves all trademark and copyright rights in and to all
389-
GitHub trademarks. GitHub's logos include, for instance, the stylized
390-
Invertocat designs that include "logo" in the file title in the following
391-
folder: [logos](app/static/logos).
392-
393-
GitHub® and its stylized versions and the Invertocat mark are GitHub's
394-
Trademarks or registered Trademarks. When using GitHub's logos, be sure to
395-
follow the GitHub [logo guidelines](https://github.com/logos).
396-
397-
</details>

0 commit comments

Comments
 (0)