X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=blobdiff_plain;f=doc%2Findex.org;h=fd1a8568280fb9535f588a98335de5189444e3a6;hp=b71817e45d6a7b6c4f3f832f5823455b01cccf22;hb=a8f54d698199d45920ad60e40629e52fd8c30340;hpb=916ecef8d7e369921e292553d89e47767ab7082b

diff --git a/doc/index.org b/doc/index.org
index b71817e..fd1a856 100644
--- a/doc/index.org
+++ b/doc/index.org
@@ -1,14 +1,19 @@
 #+TITLE: Sixth 3D - 3D engine
 
------
-- This is a subproject of [[https://www3.svjatoslav.eu/projects/sixth/][Sixth]]
-
-- Clone GIT repository using command:
-  : git clone https://www2.svjatoslav.eu/git/sixth-3d.git
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD: <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
+#+HTML_HEAD: <style type="text/css">
+#+HTML_HEAD:   footer {background-color: #111 !important;}
+#+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
+#+HTML_HEAD: </style>
 
-- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
+* General
+- This is a subproject of [[https://www3.svjatoslav.eu/projects/sixth/][Sixth]]
 
-+ This program is free software: you can redistribute it and/or modify
+- This program is free software: you can redistribute it and/or modify
   it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as
   published by the Free Software Foundation, either version 3 of the
   License, or (at your option) any later version.
@@ -20,15 +25,15 @@
 
 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
 
-* (document settings) :noexport:
-** use dark style for TWBS-HTML exporter
-#+HTML_HEAD: <link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
-#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
-#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
-#+HTML_HEAD: <style type="text/css">
-#+HTML_HEAD:   footer {background-color: #111 !important;}
-#+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
-#+HTML_HEAD: </style>
+** Source code
+- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
+
+- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=summary][Browse Git repository online]]
+
+- Clone Git repository using command:
+  : git clone https://www2.svjatoslav.eu/git/sixth-3d.git
+
+- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]].
 
 * Project description
 + See: [[https://www3.svjatoslav.eu/projects/sixth-3d-demos/][demos of current 3D engine capabilities]]
@@ -80,8 +85,11 @@ pixel.
 - As a result it is easy to run on various hardware platforms and
   operating systems.
 
-* TODO API documentation
-Documentation currently missing for the lack of time.
+* API documentation
+- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]].
+
+Note: due to a lack of time, there is still big room for improvement
+on documentation.
 
 So far best resource is to download and explore source code for:
 + 3D engine ([[https://www3.svjatoslav.eu/projects/sixth-3d/graphs/][generated code graphs]] (generated using [[https://www3.svjatoslav.eu/projects/javainspect/][JavaInspect]]))
@@ -115,6 +123,9 @@ Maven *pom.xml* file snippet:
 
 For API usage examples, see [[https://www3.svjatoslav.eu/projects/sixth-3d-demos/][demos]].
 * TODO features to add
++ read this as example, and apply improvements/fixes where applicable:
+  http://blog.rogach.org/2015/08/how-to-create-your-own-simple-3d-render.html
+
 + Partial region/frame repaint: when only one small object changed on
   the scene, it would be faster to re-render that specific area.