Skip to content

Commit 2a65266

Browse files
committed
Add README_TEMPLATE
1 parent 074b95a commit 2a65266

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README_TEMPLATE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# {{name}}
2+
3+
[![Travis][travis-img]][travis-url]
4+
[![Coveralls][coveralls-img]][coveralls-url]
5+
6+
SERT's robot code for the {{year}} {{name}} game.
7+
8+
## Building
9+
10+
Unfortunately, GradleRIO made a bad decision to use dynamic versioning which is a feature Gradle has
11+
that will find the latest version of a dependency for you. This sounds good, but is very bad for
12+
several reasons: lack of build reproducibility, stuff could change under you without notice, Gradle
13+
makes a network call to check if you have the latest version of a dependency on every build, etc.
14+
The last example is the main issue because it prevents building robot code unless you have an
15+
internet connection (which the robot doesn't). To get around this issue, you have to push code to
16+
the robot with the `--offline` flag.
17+
18+
### TL;DR
19+
20+
1. To get everything downloaded and setup, run `./gradlew build` once **while online**
21+
2. When pushing code to the robot, use `./gradlew deploy --offline`
22+
23+
[travis-img]: https://img.shields.io/travis/SouthEugeneRoboticsTeam/{{name_full}}.svg?style=flat-square
24+
[travis-url]: https://travis-ci.org/SouthEugeneRoboticsTeam/{{name_full}}
25+
[coveralls-img]: https://img.shields.io/coveralls/SouthEugeneRoboticsTeam/{{name_full}}.svg?style=flat-square
26+
[coveralls-url]: https://coveralls.io/github/SouthEugeneRoboticsTeam/{{name_full}}

0 commit comments

Comments
 (0)