Docs for new workflow
This commit is contained in:
parent
37670c12f1
commit
e9160f58b1
|
@ -41,8 +41,7 @@ We build our documentation with [MkDocs](http://www.mkdocs.org/) based on the
|
||||||
Markdown files inside the "Docs" folder. You can either directly modify them on
|
Markdown files inside the "Docs" folder. You can either directly modify them on
|
||||||
GitHub or locally in your machine.
|
GitHub or locally in your machine.
|
||||||
|
|
||||||
Once you are done with your changes, please submit a pull-request against the
|
Once you are done with your changes, please submit a pull-request.
|
||||||
`documentation` branch.
|
|
||||||
|
|
||||||
**TIP:** You can build and serve it locally by running `mkdocs` in the project's
|
**TIP:** You can build and serve it locally by running `mkdocs` in the project's
|
||||||
main folder
|
main folder
|
||||||
|
@ -80,7 +79,7 @@ new code.
|
||||||
#### Pull-requests
|
#### Pull-requests
|
||||||
|
|
||||||
Once you think your contribution is ready to be added to CARLA, please submit a
|
Once you think your contribution is ready to be added to CARLA, please submit a
|
||||||
pull-request to the `dev` branch.
|
pull-request.
|
||||||
|
|
||||||
Try to be as descriptive as possible when filling the pull-request description.
|
Try to be as descriptive as possible when filling the pull-request description.
|
||||||
Adding images and gifs may help people to understand your changes or new
|
Adding images and gifs may help people to understand your changes or new
|
||||||
|
@ -97,8 +96,7 @@ If you see a red mark, please correct your code accordingly.
|
||||||
If you modify this list please keep it up-to-date with pull_request_template.md
|
If you modify this list please keep it up-to-date with pull_request_template.md
|
||||||
-->
|
-->
|
||||||
|
|
||||||
- [ ] Make sure you are making a pull request against the `dev` branch (not `master` please)
|
- [ ] Your branch is up-to-date with the `master` branch and tested with latest changes
|
||||||
- [ ] Your branch is up-to-date with `dev` branch and tested with latest changes
|
|
||||||
- [ ] Extended the README / documentation, if necessary
|
- [ ] Extended the README / documentation, if necessary
|
||||||
- [ ] Code compiles correctly
|
- [ ] Code compiles correctly
|
||||||
- [ ] All tests passing
|
- [ ] All tests passing
|
||||||
|
|
|
@ -5,8 +5,7 @@ view the contribution guidelines, then fill out the blanks below.
|
||||||
|
|
||||||
Checklist:
|
Checklist:
|
||||||
|
|
||||||
- [ ] Make sure you are making a pull request against the `dev` branch (not `master` please)
|
- [ ] Your branch is up-to-date with the `master` branch and tested with latest changes
|
||||||
- [ ] Your branch is up-to-date with `dev` branch and tested with latest changes
|
|
||||||
- [ ] Extended the README / documentation, if necessary
|
- [ ] Extended the README / documentation, if necessary
|
||||||
- [ ] Code compiles correctly
|
- [ ] Code compiles correctly
|
||||||
- [ ] All tests passing
|
- [ ] All tests passing
|
||||||
|
|
16
README.md
16
README.md
|
@ -55,6 +55,22 @@ Felipe Codevilla, Antonio Lopez, Vladlen Koltun; PMLR 78:1-16
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Building CARLA
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Use `git clone` or download the project from this page. Note that the master
|
||||||
|
branch contains the latest fixes and features, for the latest stable code may be
|
||||||
|
best to switch to the `stable` branch.
|
||||||
|
|
||||||
|
Then follow the instruction at [How to build on Linux][buildlink].
|
||||||
|
|
||||||
|
Unfortunately we don't have yet official instructions to build on other
|
||||||
|
platforms, please check the progress for [Windows][issue21] and [Mac][issue150].
|
||||||
|
|
||||||
|
[buildlink]: http://carla.readthedocs.io/en/latest/how_to_build_on_linux
|
||||||
|
[issue21]: https://github.com/carla-simulator/carla/issues/21
|
||||||
|
[issue150]: https://github.com/carla-simulator/carla/issues/150
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue