Skip to content

Commit b59f8e7

Browse files
authored
Update README.md
1 parent dc649ac commit b59f8e7

1 file changed

Lines changed: 9 additions & 20 deletions

File tree

README.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,21 @@
11
# Unity-Scanner
22
Scans and extracts info from Unity Projects to assist with Archiving.
33

4+
The latest release, including demo/instructional video can be found here:
5+
https://github.com/shftgroup/Unity-Scanner/releases/edit/V1.0-Windows-Jan-2022
46

57

6-
This is a work in progress.
78

9+
Running the Software:
810

11+
Download the release and run the Unity Scanner (.exe or .jar depending on what you downloaded).
912

10-
How to Build:
11-
12-
Clone the repository and open the project in Idea.
13-
14-
This project requires the IntelliJ Idea IDE with Kotlin. It also requires the TornadoFX plugin which is available through the IDEA plugin manager.
15-
16-
TornadoFX requires Java RTE 1,8. Later versions are currently not compatible with TornadoFX.
17-
18-
Once the project is open in Idea, create a TornadoFX run configuration.
19-
20-
In the configuration settings, name the configuration, set the App Class to Com.example.MyApp, set the class path to TornadoFX-Gradle-Project.main.
21-
22-
Set the JRE to 1.8.
23-
24-
For more detailed instructions go here: https://medium.com/@jsj5909/5a8add96cc99
13+
To open a project, click on File -> Open Project. The open dialogue box will appear. Choose a Unity Project root folder to open the project. The root folder is the folder with the Assets subfolder in it.
2514

15+
The tabs will populate with any information extracted by the project.
2616

17+
A demo video is included with the release (.mkv file) for further instructions.
2718

28-
Running the Software:
2919

30-
To open a project, click on File -> Open Project. The open dialogue box will appear. Choose a Unity Project root folder to open the project. The root folder is the folder with the Assets subfolder in it.
31-
32-
The tabs will populate with any information extracted by the project.
20+
Build:
21+
If you wish to clone and build the project detailed build instructions can be found here: https://medium.com/@jsj5909/5a8add96cc99

0 commit comments

Comments
 (0)