mirror of
https://github.com/desktop/desktop
synced 2024-06-30 22:54:41 +00:00
Update README.md
This commit is contained in:
tidy-dev
parent
c2e8477be3
commit
b8a7026b70
130
README.md
130
README.md
|
|
@ -1,8 +1,9 @@
|
|||
# [GitHub Desktop](https://desktop.github.com)
|
||||
|
||||
[GitHub Desktop](https://desktop.github.com/) is an open-source [Electron](https://www.electronjs.org/)-based
|
||||
GitHub app. It is written in [TypeScript](https://www.typescriptlang.org) and
|
||||
uses [React](https://reactjs.org/).
|
||||
[GitHub Desktop](https://desktop.github.com/) is an open-source
|
||||
[Electron](https://www.electronjs.org/)-based GitHub app. It is written in
|
||||
[TypeScript](https://www.typescriptlang.org) and uses
|
||||
[React](https://reactjs.org/).
|
||||
|
||||
<picture>
|
||||
<source
|
||||
|
|
@ -20,77 +21,103 @@ uses [React](https://reactjs.org/).
|
|||
|
||||
Download the official installer for your operating system:
|
||||
|
||||
- [macOS](https://central.github.com/deployments/desktop/desktop/latest/darwin)
|
||||
- [macOS (Apple silicon)](https://central.github.com/deployments/desktop/desktop/latest/darwin-arm64)
|
||||
- [Windows](https://central.github.com/deployments/desktop/desktop/latest/win32)
|
||||
- [Windows machine-wide install](https://central.github.com/deployments/desktop/desktop/latest/win32?format=msi)
|
||||
- [macOS](https://central.github.com/deployments/desktop/desktop/latest/darwin)
|
||||
- [macOS (Apple silicon)](https://central.github.com/deployments/desktop/desktop/latest/darwin-arm64)
|
||||
- [Windows](https://central.github.com/deployments/desktop/desktop/latest/win32)
|
||||
- [Windows machine-wide install](https://central.github.com/deployments/desktop/desktop/latest/win32?format=msi)
|
||||
|
||||
Linux is not officially supported; however, you can find installers created for Linux from a fork of GitHub Desktop in the [Community Releases](https://github.com/desktop/desktop#community-releases) section.
|
||||
Linux is not officially supported; however, you can find installers created for
|
||||
Linux from a fork of GitHub Desktop in the
|
||||
[Community Releases](https://github.com/desktop/desktop#community-releases)
|
||||
section.
|
||||
|
||||
### 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:
|
||||
|
||||
- [macOS](https://central.github.com/deployments/desktop/desktop/latest/darwin?env=beta)
|
||||
- [macOS (Apple silicon)](https://central.github.com/deployments/desktop/desktop/latest/darwin-arm64?env=beta)
|
||||
- [Windows](https://central.github.com/deployments/desktop/desktop/latest/win32?env=beta)
|
||||
- [Windows (ARM64)](https://central.github.com/deployments/desktop/desktop/latest/win32-arm64?env=beta)
|
||||
- [macOS](https://central.github.com/deployments/desktop/desktop/latest/darwin?env=beta)
|
||||
- [macOS (Apple silicon)](https://central.github.com/deployments/desktop/desktop/latest/darwin-arm64?env=beta)
|
||||
- [Windows](https://central.github.com/deployments/desktop/desktop/latest/win32?env=beta)
|
||||
- [Windows (ARM64)](https://central.github.com/deployments/desktop/desktop/latest/win32-arm64?env=beta)
|
||||
|
||||
The release notes for the latest beta versions are available [here](https://desktop.github.com/release-notes/?env=beta).
|
||||
The release notes for the latest beta versions are available
|
||||
[here](https://desktop.github.com/release-notes/?env=beta).
|
||||
|
||||
### Community Releases
|
||||
|
||||
There are several community-supported package managers that can be used to
|
||||
install GitHub Desktop:
|
||||
- Windows users can install using [winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/) `c:\> winget install github-desktop` or [Chocolatey](https://chocolatey.org/) `c:\> choco install github-desktop`
|
||||
- macOS users can install using [Homebrew](https://brew.sh/) package manager:
|
||||
`$ brew install --cask github`
|
||||
|
||||
- Windows users can install using
|
||||
[winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/)
|
||||
`c:\> winget install github-desktop` or [Chocolatey](https://chocolatey.org/)
|
||||
`c:\> choco install github-desktop`
|
||||
- macOS users can install using [Homebrew](https://brew.sh/) package manager:
|
||||
`$ brew install --cask github`
|
||||
|
||||
Installers for various Linux distributions can be found on the
|
||||
[`shiftkey/desktop`](https://github.com/shiftkey/desktop) fork.
|
||||
|
||||
## Is GitHub Desktop right for me? What are the primary areas of focus?
|
||||
|
||||
[This document](https://github.com/desktop/desktop/blob/development/docs/process/what-is-desktop.md) describes the focus of GitHub Desktop and who the product is most useful for.
|
||||
[This document](https://github.com/desktop/desktop/blob/development/docs/process/what-is-desktop.md)
|
||||
describes the focus of GitHub Desktop and who the product is most useful for.
|
||||
|
||||
## I have a problem with GitHub Desktop
|
||||
|
||||
Note: The [GitHub Desktop Code of Conduct](https://github.com/desktop/desktop/blob/development/CODE_OF_CONDUCT.md) applies in all interactions relating to the GitHub Desktop project.
|
||||
Note: The
|
||||
[GitHub Desktop Code of Conduct](https://github.com/desktop/desktop/blob/development/CODE_OF_CONDUCT.md)
|
||||
applies in all interactions relating to the GitHub Desktop project.
|
||||
|
||||
First, please search the [open issues](https://github.com/desktop/desktop/issues?q=is%3Aopen)
|
||||
and [closed issues](https://github.com/desktop/desktop/issues?q=is%3Aclosed)
|
||||
to see if your issue hasn't already been reported (it may also be fixed).
|
||||
First, please search the
|
||||
[open issues](https://github.com/desktop/desktop/issues?q=is%3Aopen) and
|
||||
[closed issues](https://github.com/desktop/desktop/issues?q=is%3Aclosed) to see
|
||||
if your issue hasn't already been reported (it may also be fixed).
|
||||
|
||||
There is also a list of [known issues](https://github.com/desktop/desktop/blob/development/docs/known-issues.md)
|
||||
that are being tracked against Desktop, and some of these issues have workarounds.
|
||||
There is also a list of
|
||||
[known issues](https://github.com/desktop/desktop/blob/development/docs/known-issues.md)
|
||||
that are being tracked against Desktop, and some of these issues have
|
||||
workarounds.
|
||||
|
||||
If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/desktop/desktop/issues/new/choose),
|
||||
choose the right template and provide us with enough information to investigate
|
||||
further.
|
||||
If you can't find an issue that matches what you're seeing, open a
|
||||
[new issue](https://github.com/desktop/desktop/issues/new/choose), choose the
|
||||
right template and provide us with enough information to investigate further.
|
||||
|
||||
## The issue I reported isn't fixed yet. What can I do?
|
||||
|
||||
If nobody has responded to your issue in a few days, you're welcome to respond to it with a friendly ping in the issue. Please do not respond more than a second time if nobody has responded. The GitHub Desktop maintainers are constrained in time and resources, and diagnosing individual configurations can be difficult and time consuming. While we'll try to at least get you pointed in the right direction, we can't guarantee we'll be able to dig too deeply into any one person's issue.
|
||||
If nobody has responded to your issue in a few days, you're welcome to respond
|
||||
to it with a friendly ping in the issue. Please do not respond more than a
|
||||
second time if nobody has responded. The GitHub Desktop maintainers are
|
||||
constrained in time and resources, and diagnosing individual configurations can
|
||||
be difficult and time consuming. While we'll try to at least get you pointed in
|
||||
the right direction, we can't guarantee we'll be able to dig too deeply into any
|
||||
one person's issue.
|
||||
|
||||
## How can I contribute to GitHub Desktop?
|
||||
|
||||
The [CONTRIBUTING.md](./.github/CONTRIBUTING.md) document will help you get setup and
|
||||
familiar with the source. The [documentation](docs/) folder also contains more
|
||||
resources relevant to the project.
|
||||
The [CONTRIBUTING.md](./.github/CONTRIBUTING.md) document will help you get
|
||||
setup and familiar with the source. The [documentation](docs/) folder also
|
||||
contains more resources relevant to the project.
|
||||
|
||||
If you're looking for something to work on, check out the [help wanted](https://github.com/desktop/desktop/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22) label.
|
||||
If you're looking for something to work on, check out the
|
||||
[help wanted](https://github.com/desktop/desktop/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22)
|
||||
label.
|
||||
|
||||
## Building Desktop
|
||||
|
||||
To setup your development environment for building Desktop, check out: [`setup.md`](./docs/contributing/setup.md).
|
||||
To setup your development environment for building Desktop, check out:
|
||||
[`setup.md`](./docs/contributing/setup.md).
|
||||
|
||||
## More Resources
|
||||
|
||||
See [desktop.github.com](https://desktop.github.com) for more product-oriented
|
||||
information about GitHub Desktop.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## License
|
||||
|
||||
|
|
@ -104,19 +131,24 @@ designs that include "logo" in the file title in the following folder:
|
|||
mark are GitHub's Trademarks or registered Trademarks. When using GitHub's
|
||||
logos, be sure to follow the GitHub [logo guidelines](https://github.com/logos).
|
||||
See [desktop.github.com](https://desktop.github.com) for more product-oriented
|
||||
information about GitHub Desktop.
|
||||
To setup your development environment for building Desktop, check out: [`setup.md`](./docs/contributing/setup.md).
|
||||
If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/desktop/desktop/issues/new/choose),
|
||||
choose the right template and provide us with enough information to investigate
|
||||
further.
|
||||
First, please search the [open issues](https://github.com/desktop/desktop/issues?q=is%3Aopen)
|
||||
and [closed issues](https://github.com/desktop/desktop/issues?q=is%3Aclosed)
|
||||
to see if your issue hasn't already been reported (it may also be fixed).
|
||||
[GitHub Desktop](https://desktop.github.com/) is an open-source [Electron](https://www.electronjs.org/)-based
|
||||
GitHub app. It is written in [TypeScript](https://www.typescriptlang.org) and
|
||||
uses [React](https://reactjs.org/).
|
||||
There are several community-supported package managers that can be used to
|
||||
install GitHub Desktop:
|
||||
- Windows users can install using [winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/) `c:\> winget install github-desktop` or [Chocolatey](https://chocolatey.org/) `c:\> choco install github-desktop`
|
||||
- macOS users can install using [Homebrew](https://brew.sh/) package manager:
|
||||
`$ brew install --cask github`
|
||||
information about GitHub Desktop. To setup your development environment for
|
||||
building Desktop, check out: [`setup.md`](./docs/contributing/setup.md). If you
|
||||
can't find an issue that matches what you're seeing, open a
|
||||
[new issue](https://github.com/desktop/desktop/issues/new/choose), choose the
|
||||
right template and provide us with enough information to investigate further.
|
||||
First, please search the
|
||||
[open issues](https://github.com/desktop/desktop/issues?q=is%3Aopen) and
|
||||
[closed issues](https://github.com/desktop/desktop/issues?q=is%3Aclosed) to see
|
||||
if your issue hasn't already been reported (it may also be fixed).
|
||||
[GitHub Desktop](https://desktop.github.com/) is an open-source
|
||||
[Electron](https://www.electronjs.org/)-based GitHub app. It is written in
|
||||
[TypeScript](https://www.typescriptlang.org) and uses
|
||||
[React](https://reactjs.org/). There are several community-supported package
|
||||
managers that can be used to install GitHub Desktop:
|
||||
|
||||
- Windows users can install using
|
||||
[winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/)
|
||||
`c:\> winget install github-desktop` or [Chocolatey](https://chocolatey.org/)
|
||||
`c:\> choco install github-desktop`
|
||||
- macOS users can install using [Homebrew](https://brew.sh/) package manager:
|
||||
`$ brew install --cask github` test
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user