Doc: more details on remotes `origin` and `upstream` in local Git repo

This commit is contained in:
Udo Borkowski 2015-11-21 22:12:43 +01:00
parent 8d6203450d
commit 0857dc40f3
1 changed files with 1 additions and 1 deletions

View File

@ -14,7 +14,7 @@ Creating a new target involves the following key elements:
## Getting started
1. Fork the `antlr/antlr4` repository at github to your own user so that you have repository `username/antlr4`.
2. Clone `username/antlr4`, forked repository, to your local disk. Your `origin` will be the forked repository and `upstream` will be the original `antlr/antlr4` repository. Changes that you would like to contribute back to the project are done with [pull requests](https://help.github.com/articles/using-pull-requests/).
2. Clone `username/antlr4`, forked repository, to your local disk. Your remote `origin` will be the forked repository on GitHub. Add a remote `upstream` to the original `antlr/antlr4` repository (URL `https://github.com/antlr/antlr4.git`). Changes that you would like to contribute back to the project are done with [pull requests](https://help.github.com/articles/using-pull-requests/).
3. Try to build it before doing anything
```bash
$ mvn compile