mirror of https://github.com/desktop/desktop synced 2024-09-20 00:21:23 +00:00

Find a file

Brendan Forster 251859fce3 tidy up docs		2017-08-14 13:41:41 +10:00
.github	Wrap text in HTML comment tags	2017-07-06 09:29:19 -07:00
.vscode	nuking this until we can get some fresh eyes on it	2017-08-14 11:37:44 +10:00
app	Merge pull request #2438 from desktop/bespoke-copy	2017-08-11 15:00:56 +10:00
docs	tidy up docs	2017-08-14 13:41:41 +10:00
gemoji@50865e8895	Get some gemoji	2016-09-02 16:44:44 -04:00
script	Sure that's readonly too	2017-08-09 16:47:13 -04:00
tslint-rules	Merge branch 'master' into bump-tslint-pray-for-mojo	2017-05-18 21:00:41 +10:00
.gitignore	create log folder if one doesnt exist #1550	2017-06-16 13:57:27 -07:00
.gitmodules	switched this submodule over to using HTTPS	2017-04-11 17:52:04 +10:00
.node-version	update nodenv to target v7	2017-04-18 12:26:14 +10:00
.travis.yml	Add some prettiness to CI	2017-06-28 16:57:36 -07:00
appveyor.yml	Don't need this anymore	2017-07-14 15:43:53 -04:00
changelog.json	CHANGELOG	2017-08-10 14:34:34 -04:00
CODE_OF_CONDUCT.md	Add a Code of Conduct	2017-04-07 14:36:13 -04:00
CONTRIBUTING.md	and the other up-for-grabs mentions	2017-06-29 18:35:21 -07:00
LICENSE	Remove the date range	2017-04-10 13:43:44 -04:00
package.json	Merge pull request #2357 from desktop/port-build-script-to-ts	2017-08-07 11:05:52 -05:00
README.md	update README	2017-06-29 18:33:35 -07:00
tsconfig.json	Don't need these anymore	2017-05-01 11:53:30 -04:00
tslint.json	Prettified	2017-06-29 11:36:39 -07:00

README.md

GitHub Desktop

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

Where can I get it?

Download the installer for your OS:

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.

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 accepting-prs 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.