Skip to content

Commit 2a7f060

Browse files
Update readme
1 parent efaf464 commit 2a7f060

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,28 @@
22
A library for Generating paths using 254's 2014 code and following them via Talon SRX Motion Profiles
33

44
## Setup
5-
1. Add the following to your build.gradle:
5+
1. Add the following to your build.gradle, This allows you to pull the dependencies needed from a github repository:
66

7-
repositories {
8-
jcenter()
9-
maven { url "https://jitpack.io" }
10-
}
7+
repositories {
8+
jcenter()
9+
maven { url "https://jitpack.io" }
10+
}
11+
12+
2. Add this line to the dependencies block:
1113

12-
This allows you to pull the dependencies needed from a github repository.
14+
compile 'com.github.Team319:BobTrajectory:1.0.0'
1315

14-
Add this line to the dependencies block:
16+
3. Create a class that extends AbstractBobPathCreator.
1517

16-
compile 'com.github.Team319:BobTrajectory:switch_to_awt-SNAPSHOT'
18+
4. Update getTeamArcs() with any paths you need. Make sure to add the paths to the list that gets returned. If you do not add them to this list they will not be generated.
1719

18-
2. Create a class that extends the AbstractBobPathCreator class.
19-
3. In your class update getConfig() to return a SrxTranslatorConfig that resembles your robot's physical characteristics
20-
4. Update getArcs() with any paths you need. Make sure to add the paths to the asList return statement. If you do not add them to this list they will not be generated.
21-
5. Add a main method to you class that looks like this:
20+
5. Add a main method to your class that looks like this:
2221

2322
public static void main(String[] args) {
2423
new YourClassName().generatePaths();
2524
}
2625

27-
6. Run your class, your paths will generate and be placed in your robot code in the frc.arcs package. A GUI window will
28-
also appear with your paths displayed in a list of tabs.
26+
6. Run your class, your paths will generate and be placed in your robot code in the frc.arcs package. A GUI window will also appear with your paths displayed in a list of tabs.
2927

3028

31-
For more details, see the wiki: https://github.com/Team319/BobTrajectory/wiki
29+
For more details, see the wiki: https://github.com/Team319/BobTrajectory/wiki

0 commit comments

Comments
 (0)