Added runnable jar file to the web site
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sat, 1 Feb 2020 11:51:49 +0000 (13:51 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Sat, 1 Feb 2020 11:51:49 +0000 (13:51 +0200)
doc/.gitignore [new file with mode: 0644]
doc/index.html
doc/index.org
tools/update web site

diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644 (file)
index 0000000..0cc8fd2
--- /dev/null
@@ -0,0 +1,2 @@
+apidocs/
+sixth-3d-demos.jar
index 91a98ef..959ee66 100644 (file)
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <title>Sixth 3D engine demos</title>
-<!-- 2020-01-29 K 21:40 -->
+<!-- 2020-01-31 R 17:28 -->
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="Org-mode">
@@ -260,10 +260,24 @@ Goal of this project is to show off capabilities and API usage of
 </p>
 
 <p>
-All sample scenes below are rendered at interactive framerates.
+All <a href="#sec-4">example scenes in this repository</a> render at interactive
+framerates.
 </p>
+
+<p>
+Download runnable JAR file: <a href="sixth-3d-demos.jar">sixth-3d-demos.jar</a>
+</p>
+
+<p>
+To start demo application, use command:
+</p>
+<pre class="example">
+java -jar sixth-3d-demos.jar
+
+</pre>
 </div>
 </div>
+
 <div id="outline-container-sec-3" class="outline-2">
 <h2 id="sec-3"><span class="section-number-2">3</span> Navigating in space</h2>
 <div class="outline-text-2" id="text-3">
@@ -302,9 +316,10 @@ All sample scenes below are rendered at interactive framerates.
 </div>
 
 <div id="outline-container-sec-4" class="outline-2">
-<h2 id="sec-4"><span class="section-number-2">4</span> Example applications in this repository</h2>
+<h2 id="sec-4"><a id="ID-5f88b493-6ab3-4659-8280-803f75dbd5e0" name="ID-5f88b493-6ab3-4659-8280-803f75dbd5e0"></a><span class="section-number-2">4</span> Example scenes in this repository</h2>
 <div class="outline-text-2" id="text-4">
-</div><div id="outline-container-sec-4-1" class="outline-3">
+</div>
+<div id="outline-container-sec-4-1" class="outline-3">
 <h3 id="sec-4-1"><span class="section-number-3">4.1</span> Raytracing through voxels</h3>
 <div class="outline-text-3" id="text-4-1">
 
@@ -531,7 +546,7 @@ Simple test scene. Easy to implement and looks nice.
 </li>
 <li><a href="#sec-2">2. Overview</a></li>
 <li><a href="#sec-3">3. Navigating in space</a></li>
-<li><a href="#sec-4">4. Example applications in this repository</a>
+<li><a href="#sec-4">4. Example scenes in this repository</a>
 <ul class="nav">
 <li><a href="#sec-4-1">4.1. Raytracing through voxels</a></li>
 <li><a href="#sec-4-2">4.2. Conway's Game of Life</a></li>
@@ -546,7 +561,7 @@ Simple test scene. Easy to implement and looks nice.
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2020-01-29 K 21:40</p>
+<p class="date">Created: 2020-01-31 R 17:28</p>
 <p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 26.1 (<a href="http://orgmode.org">Org-mode</a> 9.1.9)</p>
 </div>
 </footer>
index 6ca368f..0fce973 100644 (file)
 Goal of this project is to show off capabilities and API usage of
 [[https://www3.svjatoslav.eu/projects/sixth-3d/][Sixth 3D]] engine.
 
-All sample scenes below are rendered at interactive framerates.
+All [[id:5f88b493-6ab3-4659-8280-803f75dbd5e0][example scenes in this repository]] render at interactive
+framerates.
+
+Download runnable JAR file: [[file:sixth-3d-demos.jar]]
+
+To start demo application, use command:
+: java -jar sixth-3d-demos.jar
+
 * Navigating in space
 | key                            | result                               |
 |--------------------------------+--------------------------------------|
@@ -46,7 +53,10 @@ All sample scenes below are rendered at interactive framerates.
 | mouse scroll wheel             | move: up, down                       |
 | dragging with mouse            | look around                          |
 
-* Example applications in this repository
+* Example scenes in this repository
+:PROPERTIES:
+:ID:       5f88b493-6ab3-4659-8280-803f75dbd5e0
+:END:
 ** Raytracing through voxels
 [[file:screenshots/raytracing fractal in voxel polygon hybrid scene.png]]
 
index 57963a5..7442ab6 100755 (executable)
@@ -3,6 +3,17 @@ cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -e "'$0' T"; exit; fi;
 
 cd ..
 
+# build application and javadoc
+mvn clean package
+
+# copy generated javadoc for publishing on website
+rm -rf doc/apidocs/
+cp -r target/apidocs/ doc/
+
+# copy runnable jar file for publishing on website
+cp target/sixth-3d-demos.jar doc/
+
+# deploy generated project homepage to server
 rsync -avz --delete  -e 'ssh -p 10006' doc/ n0@www3.svjatoslav.eu:/mnt/big/projects/sixth-3d-demos/
 
 echo ""