aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorphil <[email protected]>2016-10-18 13:35:19 +1300
committerphil <[email protected]>2016-10-18 13:35:19 +1300
commit84f94b152d65f8cd5c1d6f4d9f01e26196ba2592 (patch)
treebbd90586d7ba03bc742d2d66fbd5a1bf696255c5 /README.md
parent6acad4df603b4f504997902a88915ab48a2e5927 (diff)
Slight tidy of readme.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md73
1 files changed, 38 insertions, 35 deletions
diff --git a/README.md b/README.md
index eb05d8b..08348af 100644
--- a/README.md
+++ b/README.md
@@ -15,41 +15,44 @@ code are found in the THIRDPARTY-LICENSE-*.txt files.
The instructions below are based on eclipse, however they should work on most common IDE's
-Clone this repo, make note of the root folder you use
-Right click on the Project Explorer view and select Import
-Expand the Maven group and select Existing Maven Project and click Next
-For Root directory click Browse and find the root folder that you cloned the repo into
-There should be a pom.xml that is ticked in the Projects area
-Click Finish
-Repeat for java3d-utils
-Repeat for vecmath
-If you are new to Java3D then it might be good to repeat for java3d-examples too.
-
-Now if you right click on
-org.jdesktop.j3d.examples.hello_universe.HelloUniverse.java
-Run as ... Java Application
-You should see Java3D working
+Clone this repo, make note of the root folder you use
+Right click on the Project Explorer view and select Import
+Expand the Maven group and select Existing Maven Project and click Next
+For Root directory click Browse and find the root folder that you cloned the repo into
+There should be a pom.xml that is ticked in the Projects area
+Click Finish
+Repeat for java3d-utils
+Repeat for vecmath
+If you are new to Java3D then it might be good to repeat for java3d-examples too.
+
+Now if you right click on
+org.jdesktop.j3d.examples.hello_universe.HelloUniverse.java
+Run as ... Java Application
+You should see Java3D working
##Documentation
-For javadocs see
-http://download.java.net/media/java3d/javadoc/1.5.0/
-or
-https://github.com/scijava/java3d-javadoc
-though neither is correctly up to date
-
-For the basic overview guide see
-http://web.archive.org/web/20120626010824/http://java.sun.com/developer/onlineTraining/java3d/index.html
-This needs to be included in java3d-core as a zip and referenced
-For a description of performance see java3d-core\docs\perf_guide.txt
-
-For tutorials see
-http://www.java3d.org/tutorial.html
-
-
-For the FAQ see
-http://jogamp.org/wiki/index.php/Java3D_FAQ
-
-
-For assistance contact the forum at
-http://forum.jogamp.org/ \ No newline at end of file
+###Javadocs
+see
+<http://download.java.net/media/java3d/javadoc/1.5.0/>
+or
+<https://github.com/scijava/java3d-javadoc>
+though neither is correctly up to date
+
+###Basic overview guide
+see
+<http://web.archive.org/web/20120626010824/http://java.sun.com/developer/onlineTraining/java3d/index.html>
+This needs to be included in java3d-core as a zip and referenced
+For a description of performance see [/docs/perf_guide.txt](../docs/perf_guide.txt)
+
+###Tutorials
+see
+<http://www.java3d.org/tutorial.html>
+
+###FAQ
+see
+<http://jogamp.org/wiki/index.php/Java3D_FAQ>
+
+###General assistance
+contact the forum at
+<http://forum.jogamp.org/> \ No newline at end of file