58a59fdfbc
Google OSS policies say to name this "CONTRIBUTING.md". Change-Id: I037f52a443caacc89868b7c14af91dd3d1b681a9 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/499761 Reviewed-by: Gavin Mak <gavinmak@google.com> Tested-by: Mike Frysinger <vapier@google.com> Commit-Queue: Mike Frysinger <vapier@google.com>
55 lines
2 KiB
Markdown
55 lines
2 KiB
Markdown
# repo
|
|
|
|
Repo is a tool built on top of Git. Repo helps manage many Git repositories,
|
|
does the uploads to revision control systems, and automates parts of the
|
|
development workflow. Repo is not meant to replace Git, only to make it
|
|
easier to work with Git. The repo command is an executable Python script
|
|
that you can put anywhere in your path.
|
|
|
|
* Homepage: <https://gerrit.googlesource.com/git-repo/>
|
|
* Mailing list: [repo-discuss on Google Groups][repo-discuss]
|
|
* Bug reports: <https://issues.gerritcodereview.com/issues?q=is:open%20componentid:1370071>
|
|
* Source: <https://gerrit.googlesource.com/git-repo/>
|
|
* Overview: <https://source.android.com/source/developing.html>
|
|
* Docs: <https://source.android.com/source/using-repo.html>
|
|
* [repo Manifest Format](./docs/manifest-format.md)
|
|
* [repo Hooks](./docs/repo-hooks.md)
|
|
* [Contributing](./CONTRIBUTING.md)
|
|
* Running Repo in [Microsoft Windows](./docs/windows.md)
|
|
* GitHub mirror: <https://github.com/GerritCodeReview/git-repo>
|
|
* Postsubmit tests: <https://github.com/GerritCodeReview/git-repo/actions>
|
|
|
|
## Contact
|
|
|
|
Please use the [repo-discuss] mailing list or [issue tracker] for questions.
|
|
|
|
You can [file a new bug report][new-bug] under the "repo" component.
|
|
|
|
Please do not e-mail individual developers for support.
|
|
They do not have the bandwidth for it, and often times questions have already
|
|
been asked on [repo-discuss] or bugs posted to the [issue tracker].
|
|
So please search those sites first.
|
|
|
|
## Install
|
|
|
|
Many distros include repo, so you might be able to install from there.
|
|
```sh
|
|
# Debian/Ubuntu.
|
|
$ sudo apt-get install repo
|
|
|
|
# Gentoo.
|
|
$ sudo emerge dev-vcs/repo
|
|
```
|
|
|
|
You can install it manually as well as it's a single script.
|
|
```sh
|
|
$ mkdir -p ~/.bin
|
|
$ PATH="${HOME}/.bin:${PATH}"
|
|
$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
|
|
$ chmod a+rx ~/.bin/repo
|
|
```
|
|
|
|
|
|
[new-bug]: https://issues.gerritcodereview.com/issues/new?component=1370071
|
|
[issue tracker]: https://issues.gerritcodereview.com/issues?q=is:open%20componentid:1370071
|
|
[repo-discuss]: https://groups.google.com/forum/#!forum/repo-discuss
|