Skip to content

Commit f3e1232

Browse files
committed
Fixed images, little README update
1 parent ed6b8d6 commit f3e1232

File tree

10 files changed

+41
-33
lines changed

10 files changed

+41
-33
lines changed

tutorials/.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
FusionExporterCodelab/
2-
CodeSimulationCodelab/
1+
out/
2+

tutorials/ConfigMode.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ feedback link: https://github.com/Autodesk/synthesis/issues
1313

1414
Configure Mode allows you to change and fine tune aspects of your robot to better test and simulate its behavior on the field. Configure Mode is available in both Practice and Match Modes and is accessible via the side panel.
1515

16+
<<<<<<< Updated upstream
1617
[<img src="img/synthesis/config-mode.png" alt="image" width="50%" height="50%"/>](img/synthesis/config-mode.png)
18+
=======
19+
![image_caption](img/synthesis/config-mode.png)
20+
>>>>>>> Stashed changes
1721
1822
In each configuration panel, you will be able to cancel and save your modifications. You will also be given the option to `Session Save`, saving your changes until you quit the session. If you want the changes you make to that robot to be saved permanently, hit the `Save` button on the far right.
1923

@@ -33,7 +37,7 @@ Similarly to pickup configuration, you’re able to move your ejection path in t
3337

3438
Motor configuration allows you to modify the motors on your robot. Using the slide bars assigned to each motor, you can adjust the target velocity accordingly.
3539

36-
[<img src="img/synthesis/motor-config.png" alt="image" width="50%" height="50%"/>](img/synthesis/motor-config.png)
40+
![image_caption](img/synthesis/motor-config.png)
3741

3842
<sub>Pictured here are the motors on Team 2471's 2018 robot.</sub>
3943

@@ -44,7 +48,7 @@ Motor configuration allows you to modify the motors on your robot. Using the sli
4448

4549
In drivetrain configuration, you can change the drivetrain your robot uses, which can then be adjusted in motor configuration and controls.
4650

47-
[<img src="img/synthesis/change-drivetrain-panel.png" alt="image" width="50%" height="50%"/>](img/synthesis/change-drivetrain-panel.png)
51+
![image_caption](img/synthesis/change-drivetrain-panel.png)
4852

4953
The drivetrains available on Synthesis are as the following:
5054

tutorials/FusionExporter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ For information regarding the manual install process visit the [Synthesis Fusion
1919

2020
After installing Synthesis, the exporter addin should automatically start up when you open Fusion 360 (given that it was selected during the Synthesis install process). Navigate to the Utilities tab and you should see a Synthesis button.
2121

22-
[<img src="img/fusion/exporter-button.png" alt="image" width="50%" height="50%"/>](img/fusion/exporter-button.png)
22+
![image_caption](img/fusion/exporter-button.png)
2323

2424
After clicking the button, a panel will open up. This is the exporter. In this panel, you can provide us with most of the extra data we need to properly simulate your robot or field in Synthesis.
2525

26-
[<img src="img/fusion/exporter-panel.png" alt="image" width="50%" height="50%"/>](img/fusion/exporter-panel.png)
26+
![image_caption](img/fusion/exporter-panel.png)
2727

2828
### General Tab
2929

30-
[<img src="img/fusion/exporter-general.png" alt="image" width="50%" height="50%"/>](img/fusion/exporter-general.png)
30+
![image_caption](img/fusion/exporter-general.png)
3131

3232
This is where you will do most of your configuring. Here is a basic overview of the options you will find in the general tab.
3333

@@ -50,7 +50,7 @@ Notes:
5050

5151
### Advanced Tab
5252

53-
[<img src="img/fusion/exporter-advanced.png" alt="image" width="50%" height="50%"/>](img/fusion/exporter-advanced.png)
53+
![image_caption](img/fusion/exporter-advanced.png)
5454

5555
The advanced tab has some optional toggles for disabling / enabling some more advanced features. If your not confident in your ability with the Synthesis exporter, it is recommended that you leave these options alone.
5656

tutorials/Makefile

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,28 @@
22

33
all: FusionExporter CodeSimulation ConfigMode PracticeMode MatchMode ReplayMode RobotBuilder Utilities
44

5+
OUTPUT_DIRECTORY := ./out/
6+
57
FusionExporter:
6-
claat export -o ./ FusionExporter.md
8+
claat export -o $(OUTPUT_DIRECTORY) FusionExporter.md
79

810
CodeSimulation:
9-
claat export -o ./ CodeSimulation.md
11+
claat export -o $(OUTPUT_DIRECTORY) CodeSimulation.md
1012

1113
ConfigMode:
12-
claat export -o ./ ConfigMode.md
14+
claat export -o $(OUTPUT_DIRECTORY) ConfigMode.md
1315

1416
MatchMode:
15-
claat export -o ./ MatchMode.md
17+
claat export -o $(OUTPUT_DIRECTORY) MatchMode.md
1618

1719
PracticeMode:
18-
claat export -o ./ PracticeMode.md
20+
claat export -o $(OUTPUT_DIRECTORY) PracticeMode.md
1921

2022
ReplayMode:
21-
claat export -o ./ ReplayMode.md
23+
claat export -o $(OUTPUT_DIRECTORY) ReplayMode.md
2224

2325
RobotBuilder:
24-
claat export -o ./ RobotBuilder.md
26+
claat export -o $(OUTPUT_DIRECTORY) RobotBuilder.md
2527

2628
Utilities:
27-
claat export -o ./ Utilities.md
29+
claat export -o $(OUTPUT_DIRECTORY) Utilities.md

tutorials/MatchMode.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Match Mode is a new mode in Synthesis that allows you to simulate a FIRST match
1717

1818
After opening Synthesis, select Single Player. There, you should be able to choose between Practice Mode and Match Mode.
1919

20-
<img src="img/synthesis/choose-mode-modal.png" alt="image" width="50%" height="50%"/>
20+
![image_caption](img/synthesis/choose-mode-modal.png)
2121

2222
### Preparing a Match
2323

2424
Once Match Mode is selected, you will be able to choose your robots for each alliance, as well as a field.
2525

2626
Next, you will be able to view your selected field and set the spawn locations for each robot. You can spawn your robots anywhere within the field by selecting each robot and clicking on the location.
2727

28-
<img src="img/synthesis/match-mode-setup.png" alt="image" width="50%" height="50%"/>
28+
![image_caption](img/synthesis/match-mode-setup.png)
2929

3030
## Scoring Zones
3131

@@ -40,15 +40,15 @@ After setting your robot’s spawning locations, you can place down scoring zone
4040
* Persistent Points:
4141
* Points earned remain even when the game piece leaves the scoring zone.
4242

43-
<img src="img/synthesis/match-mode-scoring.png" alt="image" width="50%" height="50%"/>
43+
![image_caption](img/synthesis/match-mode-scoring.png)
4444

4545
### Beginning a Match
4646

4747
Once you have set your scoring zones, the match will begin. There is a 15 second phase meant to mirror autonomous mode, followed by the 135 second tele-op period. Each phase is marked with FRC field audio.
4848

4949
At the end of the match, you will get a panel showing the points earned. Here, you have the option to exit out of match mode, restart the match, or reconfigure the match with different bots or a different field.
5050

51-
<img src="img/synthesis/match-mode-results.png" alt="image" width="50%" height="50%"/>
51+
![image_caption](img/synthesis/match-mode-results.png)
5252

5353
## Need More Help?
5454

tutorials/PracticeMode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ View refers to your camera view. In Synthesis, there are four types for you to c
2525
- **Overview**: Overview is a static camera pointed down at the field. Use scroll to zoom in and out.
2626
- **Driver Station**: A camera view meant to mimic a driver’s view from the Driver station. Use right click and WASD to position the camera, and scroll to zoom. This view is similar to Freecam, but always points towards your robot.
2727

28-
[<img src="img/synthesis/view-panel.png" alt="image" width="50%" height="50%"/>](img/synthesis/view-panel.png)
28+
![image_caption](img/synthesis/view-panel.png)
2929

3030
## Configure
3131

@@ -37,7 +37,7 @@ To download preloaded robots and fields, open Download Assets and select which m
3737

3838
If this is the first time you are running Synthesis, you won’t be able to spawn anything without downloading the models first.
3939

40-
[<img src="img/synthesis/asset-downloader.png" alt="image" width="50%" height="50%"/>](img/synthesis/asset-downloader.png)
40+
![image_caption](img/synthesis/asset-downloader.png)
4141

4242
## Scoring Zones
4343

tutorials/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@ or
2020

2121
or
2222

23-
`make TUTORIAL`
23+
`make [tutorial]`
24+
25+
#### Make Script
26+
27+
Using the make script will dump all the resulting codelabs into an `out/` directory.
2428

2529
## Usage
2630

tutorials/ReplayMode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Replay Mode is a feature that allows you to rewind the **last 5 seconds of game
1313

1414
By hitting `Tab` on your keyboard, a slider will show up on the bottom of your screen. You can pull the slider in either direction to replay your simulation. Hit `Tab` again to close out of Replay Mode.
1515

16-
[<img src="img/synthesis/replay-mode.png" alt="image" width="50%" height="50%"/>](img/synthesis/replay-mode.png)
16+
![image_caption](img/synthesis/replay-mode.png)
1717

1818
## Need More Help?
1919

tutorials/RobotBuilder.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ feedback link: https://github.com/Autodesk/synthesis/issues
1313

1414
Robot Builder is a new feature in Synthesis that lets you import parts to put together a custom robot, without having to CAD and export a full model from an external software.
1515

16-
[<img src="img/synthesis/robot-builder.png" alt="image" width="50%" height="50%"/>](img/synthesis/robot-builder.png)
16+
![image_caption](img/synthesis/robot-builder.png)
1717

1818
## Part Editor
1919

@@ -25,7 +25,7 @@ In Download Assets, you can download preloaded part files to use in Part Editor.
2525

2626
Once you enter Part Editor, a panel will open up. In this panel, you can add and remove connection points. These will act as the joint for your part.
2727

28-
[<img src="img/synthesis/robot-editor-1.png" alt="image" width="50%" height="50%"/>](img/synthesis/robot-editor-1.png)
28+
![image_caption](img/synthesis/robot-editor-1.png)
2929

3030
When the connection point is selected on the panel, you’ll be able to move and place the connection point as you see fit as well as orient the way an attached part will face by rotating the point.
3131

@@ -35,7 +35,7 @@ The large arrow is an indicator of which way the attached part will face.
3535

3636
In Robot Editor, you’re able to use the parts created in Part Editor to put together a robot. Just press Add and select the part you want to use.
3737

38-
[<img src="img/synthesis/robot-editor-2.png" alt="image" width="50%" height="50%"/>](img/synthesis/robot-editor-2.png)
38+
![image_caption](img/synthesis/robot-editor-2.png)
3939

4040
Once you have the parts loaded in, use the panel to select a part you want to join. If a part has multiple connection points, you can choose which one to attach your second part to by moving your cursor over the point.
4141

tutorials/Utilities.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,15 @@ Multibot is a feature that allows you to switch between different robots that yo
1818
have on the field. It also allows you to load in additional bots, or remove
1919
unwanted ones.
2020

21-
[<img src="img/synthesis/multibot.png" alt="image" width="50%" height="50%"/>](img/synthesis/multibot.png)
21+
![image_caption](img/synthesis/multibot.png)
2222

2323
## God Mode
2424

2525
When you open up the control panel, there is a keybind for something called `God Mode`.
2626
When `G` is held (or whichever key you choose) you have the ability to pick up and drag any dynamic / movable object, including the robot.
2727

28-
<p align="center">
29-
<a>[<img src="img/synthesis/settings-panel.png" alt="image" width="49.5%" height="50%"/>](img/synthesis/settings-panel.png)</a>
30-
<a>[<img src="img/synthesis/god-mode-dragging.png" alt="image" width="49.5%" height="50%"/>](img/synthesis/god-mode-dragging.png)</a>
31-
</p>
28+
![image_caption](img/synthesis/god-mode-dragging.png)
29+
![image_caption](img/synthesis/settings-panel.png)
3230

3331
<sub>Pictured here is a robot being dragged while in *God Mode*.</sub>
3432

@@ -46,7 +44,7 @@ Synthesis’ settings panel lets you calibrate your screen size, image quality,
4644

4745
Theme Editor is a new feature that allows you to choose between preset themes, as well as create your own custom ones.
4846

49-
[<img src="img/synthesis/theme-editor.png" alt="image" width="50%" height="50%"/>](img/synthesis/theme-editor.png)
47+
![image_caption](img/synthesis/theme-editor.png)
5048

5149
## Need More Help?
5250

0 commit comments

Comments
 (0)