initial commit

Author: i-make-robots

.gitignore

@@ -1,24 +1,38 @@
-# Compiled class file
-*.class
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
 
-# Log file
-*.log
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
 
-# BlueJ files
-*.ctxt
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
 
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
 
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
+### VS Code ###
+.vscode/
 
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-replay_pid*
+### Mac OS ###
+.DS_Store

.idea/.gitignore

@@ -0,0 +1,27 @@
+# ShowTHR
+
+Read a THR file and simulate the motion of a ball rolling over a table covered in sand.
+
+## Usage
+
+```java -jar ShowTHR.jar <source.thr> <output> [-w <width>] [-h <height>] [-d <depth>] [-b <radius>]```
+
+- `<source.thr>`: The path to the THR file.
+- `<output>`: The path to the output file.  ImageIO supported formats are accepted, including pio and webp.
+- `-w <width>`: The width of the output image.  Default is 300.
+- `-h <height>`: The height of the output image.  Default is 300.
+- `-b <radius>`: The radius of the ball.  Default is 5.
+- `-d <depth>`: The starting depth of the sand.  Default is 2.
+
+## Example
+
+![Example](sand_simulation.png)
+
+## Notes
+
+The intensity of the output image is dictated by highest peak in the sand simulation.  The output image is normalized to the range [0, 255].
+If one point of sand is very tall, the rest of the image will be very dark.
+
+## License
+
+Apache 2.0 License