Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 4.15 KB

README.md

File metadata and controls

80 lines (56 loc) · 4.15 KB

Travis CircleCI AppVeyor Build Status license 90+% TypeScript

GitHub Desktop is an open source Electron-based GitHub app. It is written in TypeScript and uses React.

GitHub Desktop screenshot - Windows

Where can I get it?

Download the official installer for your operating system:

There are several community-supported package managers that can be used to install Github Desktop.

  • Windows users can install using Chocolatey package manager: c:\> choco install github-desktop
  • macOS users can install using Homebrew package manager: $ brew cask install github
  • Arch Linux users can install the latest version from the AUR.

You can install this alongside your existing GitHub Desktop for Mac or GitHub Desktop for Windows application.

NOTE: there is no current migration path to import your existing repositories into the new application - you can drag-and-drop your repositories from disk onto the application to get started.

Beta Channel

Want to test out new features and get fixes before everyone else? Install the beta channel to get access to early builds of Desktop:

I have a problem with GitHub Desktop

First, please search the open issues and closed issues to see if your issue hasn't already been reported (it may also be fixed).

If you can't find an issue that matches what you're seeing, open a new issue and fill out the template to provide us with enough information to investigate further.

How can I contribute to GitHub Desktop?

The CONTRIBUTING.md document will help you get setup and familiar with the source. The documentation folder also contains more resources relevant to the project.

If you're looking for something to work on, check out the help wanted label.

More Resources

See desktop.github.com for more product-oriented information about GitHub Desktop.

License

MIT

The MIT license grant is not for GitHub's trademarks, which include the logo designs. GitHub reserves all trademark and copyright rights in and to all GitHub trademarks. GitHub's logos include, for instance, the stylized Invertocat designs that include "logo" in the file title in the following folder: logos.

GitHub® and its stylized versions and the Invertocat mark are GitHub's Trademarks or registered Trademarks. When using GitHub's logos, be sure to follow the GitHub logo guidelines.