Skip to content

Commit ed2a1df

Browse files
Update exporter readmes for installer
1 parent 60e7297 commit ed2a1df

File tree

3 files changed

+56
-12
lines changed

3 files changed

+56
-12
lines changed

installer/README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
# Installing the Synthesis Fusion Exporter
1+
# Installers
22

3-
## Manual Install
3+
We recently transitioned to a platform independent, web-based application. As such, we no longer maintain a installer for the core simulator. We do, however, still have one for our Fusion Exporter.
4+
5+
## Installing the Synthesis Fusion Exporter
6+
7+
### Using an Installer
8+
9+
- Visit [synthesis.autodesk.com/download](https://synthesis.autodesk.com/download.html) and select the installer for your operating system.
10+
- Note that there is no installer for Linux since Fusion is only supported on Windows and Mac.
11+
- Once you have downloaded the installer for your operating system (`.exe` for Windows and `.pkg` for Mac) go ahead and run the executable.
12+
- Since we do not code sign our installers (as interns of Autodesk we have very little control over this) you may get a warning from your operating system.
13+
- For Mac to get around this see [this](https://support.apple.com/en-tm/guide/mac-help/mh40616/mac) guide for more information.
14+
- If you are at all concerned that we are doing something nefarious please feel free to [install the exporter manually.](#manual-install)
15+
- Alternatively, you can even inspect how we build our installers [here](./exporter/) and build them yourself.
16+
17+
### <a name="manual-install"></a> Manual Install
418

519
- Navigate to [`synthesis.autodesk.com/download`](https://synthesis.autodesk.com/download.html).
620
- Find the Exporter source code zip download.
@@ -25,7 +39,3 @@ under the `Utilities` tab.
2539
![image_caption](../tutorials/img/fusion/fusion-utilities-with-synthesis.png)
2640

2741
Thanks for installing the Synthesis Fusion Exporter! For any additional help visit our [Synthesis Community Discord Server](https://www.discord.gg/hHcF9AVgZA) where you can talk directly to our developers.
28-
29-
## Using an Installer
30-
31-
Our automatic installer is still in development, visit the [Synthesis Discord Server](https://www.discord.gg/hHcF9AVgZA) for updates and any manual installing help.

installer/exporter/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Synthesis Exporter Installers
2+
3+
This `readme` is for developers of Synthesis or those looking to build the installers themselves, if you are just looking for how to install our Fusion Exporter please navigate to [`/installer/`](../).
4+
5+
## Windows
6+
7+
The windows installer has the following prerequisites:
8+
- Python `3.9` or newer and pip.
9+
- And that's it!
10+
11+
### To Build:
12+
13+
Once you have verified that python and pip are installed on your computer:
14+
- Open a powershell window and navigate to [`/installer/exporter/Windows/`]
15+
- Run `./build.bat` in powershell.
16+
- After some time you should see `installer.exe` in your current directory.
17+
- And that's it! You have now built the Synthesis Exporter Installer for Windows!
18+
- You can then run the `.exe` from file explorer or alternatively, for debugging purposes, run `./installer.exe` from the terminal.
19+
20+
## MacOS
21+
22+
The Mac installer has zero prerequisites. Hooray!
23+
24+
### To Build:
25+
26+
- Navigate to [`/installer/exporter/OSX/`](./OSX/).
27+
- Run `./build.sh` in your terminal.
28+
- You should then find `SynthesisExporterInstaller.pkg` in your current directory.
29+
- And that's it! You now have built the Synthesis Exporter Installer for MacOS!

tutorials/FusionExporter.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,17 @@ For information regarding the manual install process visit the [Synthesis Fusion
1717

1818
## Getting Started
1919

20-
### Manual Install
20+
### Using an Installer
21+
22+
- Visit [synthesis.autodesk.com/download](https://synthesis.autodesk.com/download.html) and select the installer for your operating system.
23+
- Note that there is no installer for Linux since Fusion is only supported on Windows and Mac.
24+
- Once you have downloaded the installer for your operating system (`.exe` for Windows and `.pkg` for Mac) go ahead and run the executable.
25+
- Since we do not code sign our installers (as interns of Autodesk we have very little control over this) you may get a warning from your operating system.
26+
- For Mac to get around this see [this](https://support.apple.com/en-tm/guide/mac-help/mh40616/mac) guide for more information.
27+
- If you are at all concerned that we are doing something nefarious please feel free to [install the exporter manually.](#manual-install)
28+
- Alternatively, you can even inspect how we build our installers [here](./exporter/) and build them yourself.
29+
30+
### <a name="manual-install"></a> Manual Install
2131

2232
- Navigate to [`synthesis.autodesk.com/download`](https://synthesis.autodesk.com/download.html).
2333
- Find the Exporter source code zip download.
@@ -43,11 +53,6 @@ under the `Utilities` tab.
4353

4454
Thanks for installing the Synthesis Fusion Exporter! For any additional help visit our [Synthesis Community Discord Server](https://www.discord.gg/hHcF9AVgZA) where you can talk directly to our developers.
4555

46-
### Using an Installer
47-
48-
Our automatic installer is still in development, visit the [Synthesis Discord Server](https://www.discord.gg/hHcF9AVgZA) for updates and any manual installing help.
49-
50-
5156
### Launching the Exporter
5257

5358
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.

0 commit comments

Comments
 (0)