Skip to content

Commit eadf928

Browse files
garfieldnategarfieldnate
committed
Improve documentation
1 parent 160b916 commit eadf928

3 files changed

Lines changed: 47 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,36 @@ here: https://soar.eecs.umich.edu/soar_manual/08_SpatialVisualSystem/.
2121

2222
Screenshots are available on the [wiki](https://github.com/garfieldnate/JavaSVSViewer/wiki).
2323

24-
## Installing
24+
## Pre-built Binaries
2525

26-
* Standalone applications built via jpackage in CI
27-
* For Mac, I notice that the .pkg works but the .dmg does not
26+
See the [latest release](https://github.com/garfieldnate/JavaSVSViewer/releases/latest) for a pre-built binary for your
27+
platform.
2828

29-
## Format
29+
* Standalone applications are built via jlink/jpackage in CI
30+
* Open issues on the packaging: https://github.com/garfieldnate/JavaSVSViewer/issues/2
31+
32+
## Development
33+
34+
### Executing from Source
35+
36+
./gradlew run
37+
38+
### Format
3039

3140
We use [google-java-format](https://github.com/google/google-java-format) to format the source files.
3241

3342
For IntelliJ, install and configure the plugin, and enable "Reformat code" under the "Actions on Save" setting.
3443

35-
## Editing
36-
37-
You may want SceneBuilder in IntelliJ to edit the fxml file:
38-
https://www.jetbrains.com/help/idea/opening-fxml-files-in-javafx-scene-builder.html#download-scene-builder-from-ide
44+
### Editors
3945

40-
## Building/Running
46+
The main class to run is `SvsViewerApplication`.
4147

42-
### IntelliJ
48+
Running in IntelliJ has been broken since adding a non-module dependency. The error is:
4349

44-
Load in IntelliJ and run SvsViewerApplication.java.
50+
Error occurred during initialization of boot layer
51+
java.lang.module.FindException: Module quickhull3d not found, required by edu.umich.soar.svsviewer
4552

46-
### Standalone JAR
53+
### Building a Standalone JAR
4754

4855
Run the Jlink build, then cd build/jlinkbase/jlinkjars and do:
4956

‎build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ plugins {
77
}
88

99
group 'edu.umich.soar.svsviewer'
10-
version '1.0.2'
10+
version '1.0.3'
1111

1212
repositories {
1313
mavenCentral()

‎src/main/resources/edu/umich/soar/svsviewer/thor-soar-input.txt‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,30 @@
8181
+S1 +Vase75 v 0.5 0.5 0.5 0.5 0.5 -0.5 0.5 -0.5 0.5 0.5 -0.5 -0.5 -0.5 0.5 0.5 -0.5 0.5 -0.5 -0.5 -0.5 0.5 -0.5 -0.5 -0.5 p 1.98803 -2.48701 0.678383 r 0 0 0 1 s 0.189224 0.189229 0.244053
8282
+S1 +Window76 v 0.5 0.5 0.5 0.5 0.5 -0.5 0.5 -0.5 0.5 0.5 -0.5 -0.5 -0.5 0.5 0.5 -0.5 0.5 -0.5 -0.5 -0.5 0.5 -0.5 -0.5 -0.5 p -2.29608 -1.20157 1.52007 r 0 0 0 1 s 0.210566 1.79838 1.23625
8383
+S1 +WineBottle77 v 0.5 0.5 0.5 0.5 0.5 -0.5 0.5 -0.5 0.5 0.5 -0.5 -0.5 -0.5 0.5 0.5 -0.5 0.5 -0.5 -0.5 -0.5 0.5 -0.5 -0.5 -0.5 p -1.00101 -2.58384 1.80791 r 0 0 0 1 s 0.088188 0.088188 0.325798
84+
# Example updates to robot
85+
COMMAND: +S1 +view_dir p -0.6 1.75 1.601 r 0.258819 4.48288e-08 0.965926 -1.67303e-07 s 0.75 0.375 0.375
86+
COMMAND: +S1 +view_dir p -0.6 1.75 1.601 r 0 0 1 -1.73205e-07 s 0.75 0.375 0.375
87+
COMMAND: +S1 +view_dir p -0.6 1.75 1.601 r -0.258819 -4.48288e-08 0.965926 -1.67303e-07 s 0.75 0.375 0.375
88+
COMMAND: +S1 +view_dir p -0.6 1.75 1.601 r -0.5 -8.66026e-08 0.866025 -1.5e-07 s 0.75 0.375 0.375
89+
COMMAND: +S1 +view_dir p -0.6 1.75 1.601 r -0.258819 -4.48288e-08 0.965926 -1.67303e-07 s 0.75 0.375 0.375
90+
COMMAND: +S1 +view_dir p -0.6 1.75 1.601 r 0 0 1 -1.73205e-07 s 0.75 0.375 0.375
91+
COMMAND: +S1 +robot_pos p -0.5 1.75 0.900999 r 0 0 0.707107 0.707107 s 1 1 1
92+
COMMAND: +S1 +robot_body p -0.5 1.95 0.900999 r 0 0 0.707107 0.707107 s 0.5 0.5 1
93+
COMMAND: +S1 +view_dir p -0.5 1.85 1.601 r 0 0 0.707107 0.707107 s 0.75 0.375 0.375
94+
COMMAND: +S1 +robot p -0.5 1.75 0.900999 r 0 0 0.707107 0.707107 s 1 1 1
95+
COMMAND: +S1 +robot_pos p -0.5 1.75 0.900999 r 0 0 0 1 s 1 1 1
96+
COMMAND: +S1 +robot_body p -0.3 1.75 0.900999 r 0 0 0 1 s 0.5 0.5 1
97+
COMMAND: +S1 +view_dir p -0.4 1.75 1.601 r 0 0 0 1 s 0.75 0.375 0.375
98+
COMMAND: +S1 +robot p -0.5 1.75 0.900999 r 0 0 0 1 s 1 1 1
99+
COMMAND: +S1 +robot_pos p -0.5 1.75 0.900999 r 0 0 -0.707107 0.707107 s 1 1 1
100+
COMMAND: +S1 +robot_body p -0.5 1.55 0.900999 r 0 0 -0.707107 0.707107 s 0.5 0.5 1
101+
COMMAND: +S1 +view_dir p -0.5 1.65 1.601 r 0 0 -0.707107 0.707107 s 0.75 0.375 0.375
102+
COMMAND: +S1 +robot p -0.5 1.75 0.900999 r 0 0 -0.707107 0.707107 s 1 1 1
103+
COMMAND: +S1 +robot_pos p -0.5 1.75 0.900999 r 0 0 1 -1.73205e-07 s 1 1 1
104+
COMMAND: +S1 +robot_body p -0.7 1.75 0.900999 r 0 0 1 -1.73205e-07 s 0.5 0.5 1
105+
COMMAND: +S1 +view_dir p -0.6 1.75 1.601 r 0 0 1 -1.73205e-07 s 0.75 0.375 0.375
106+
COMMAND: +S1 +robot p -0.5 1.75 0.900999 r 0 0 1 -1.73205e-07 s 1 1 1
107+
COMMAND: +S1 +robot_pos p -0.5 1.75 0.900999 r 0 0 0.707107 0.707107 s 1 1 1
108+
COMMAND: +S1 +robot_body p -0.5 1.95 0.900999 r 0 0 0.707107 0.707107 s 0.5 0.5 1
109+
COMMAND: +S1 +view_dir p -0.5 1.85 1.601 r 0 0 0.707107 0.707107 s 0.75 0.375 0.375
110+
COMMAND: +S1 +robot p -0.5 1.75 0.900999 r 0 0 0.707107 0.707107 s 1 1 1

0 commit comments

Comments
 (0)