mirror of https://github.com/rusefi/jzy3d-api.git
clean readmes
This commit is contained in:
parent
768cb3ca3d
commit
2af5f8206f
74
README.md
74
README.md
|
@ -15,35 +15,65 @@ API and modules
|
|||
Application will require <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-api/src/api">jzy3d-api</a> <i>plus</i> classes to address a specific windowing environement (AWT, SWT, Swing). The API itself has no dependency to AWT, making it buildable for Android environement.
|
||||
|
||||
Code specific to a target windowing environement is made available through modules (or sometime source folder separation):
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-api/src/awt">jzy3d-awt</a> : provides AWT canvases (source folder separation but part of jzy3d-api build)
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-api/src/swing">jzy3d-swing</a> : provides Swing canvases (source folder separation but jzy3d-api build)
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-api/src/awt">jzy3d-api/awt</a> : provides AWT canvases (source folder separation but part of jzy3d-api build)
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-api/src/swing">jzy3d-api/swing</a> : provides Swing canvases (source folder separation but jzy3d-api build)
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-swt">jzy3d-swt</a> : provides a wrapper on AWT canvas to embed a chart in a SWT application.
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-javafx">jzy3d-javafx</a> : render in Java FX applications.
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-jdt-core">jzy3d-jdt-core</a> : a clone of JDT, for Java Delaunay Triangulation
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-svm-mapper">jzy3d-svm-mapper</a> : fit a surface out of set of points using an SVM regression model
|
||||
- <a href="https://github.com/jzy3d/jzy3d-api/blob/master/jzy3d-tools-libsvm">jzy3d-tools-libsvm</a> : a wrapper on LibSVM
|
||||
|
||||
|
||||
Additional modules kept separated demonstrate side works on Jzy3d
|
||||
- <a href="https://github.com/jzy3d/bigpicture">jzy3d-bigture</a> : drivers to few big data storage to draw massive amount of points
|
||||
- <a href="https://github.com/jzy3d/jzy3d-graphs">jzy3d-graph</a> : 3d graphs layout and rendering using Gephi toolkit
|
||||
- <a href="https://github.com/jzy3d/jzy3d-spectro">jzy3d-spectro</a> : 3d spectrogram
|
||||
|
||||
The API has optional extensions bundled by a parent and several children module stored in separated Git repositories:
|
||||
- <a href="https://github.com/jzy3d/jzy3d-extensions">jzy3d-extensions</a> : gather 5 optional modules that may be checkout separately as well (Depth peeling, Graphs, G2D, )
|
||||
|
||||
|
||||
Jzy3d Maven Repository
|
||||
-----------------------------------
|
||||
- Release versions WILL stand on maven central
|
||||
- Snapshot versions stand on Jzy3d maven repository:
|
||||
<pre>
|
||||
<code>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>jzy3d-snapshots</id>
|
||||
<name>Jzy3d Snapshots</name>
|
||||
<url>http://maven.jzy3d.org/snapshots </url>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>jzy3d-releases</id>
|
||||
<name>Jzy3d Snapshots</name>
|
||||
<url>http://maven.jzy3d.org/releases </url>
|
||||
</repository>
|
||||
</repositories>
|
||||
</code>
|
||||
</pre>
|
||||
- To add Jzy3d to your project
|
||||
|
||||
release
|
||||
<pre>
|
||||
<code>
|
||||
<dependency>
|
||||
<groupId>org.jzy3d</groupId>
|
||||
<artifactId>jzy3d-api</artifactId>
|
||||
<version>1.0.1-SNAPSHOT</version>
|
||||
</dependency>
|
||||
</code>
|
||||
</pre>
|
||||
snapshot
|
||||
<pre>
|
||||
<code>
|
||||
<dependency>
|
||||
<groupId>org.jzy3d</groupId>
|
||||
<artifactId>jzy3d-api</artifactId>
|
||||
<version>1.0.1-SNAPSHOT</version>
|
||||
</dependency>
|
||||
</code>
|
||||
</pre>
|
||||
|
||||
|
||||
- Maven artifacts are stored there:
|
||||
<pre>
|
||||
<code>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>jzy3d-snapshots</id>
|
||||
<name>Jzy3d Snapshots</name>
|
||||
<url>http://maven.jzy3d.org/snapshots </url>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>jzy3d-releases</id>
|
||||
<name>Jzy3d Releases</name>
|
||||
<url>http://maven.jzy3d.org/releases </url>
|
||||
</repository>
|
||||
</repositories>
|
||||
</code>
|
||||
</pre>
|
||||
|
||||
Building the projects with Maven
|
||||
-----------------------------------
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
A SVM based mapper
|
||||
===================
|
||||
|
||||
This project is part of a <a href="https://github.com/jzy3d/jzy3d-master">multi-modules project</a>
|
||||
|
||||
Using a Support Vector Machine regression model allows defining an approximated surface model out of a set of 3d points.
|
||||
|
||||
|
|
|
@ -1,8 +1,6 @@
|
|||
jzy3d-tools-libsvm
|
||||
===================
|
||||
|
||||
This project is part of a <a href="https://github.com/jzy3d/jzy3d-master">multi-modules project</a>
|
||||
|
||||
A clone of http://www.csie.ntu.edu.tw/~cjlin/libsvm/
|
||||
|
||||
Contains:
|
||||
|
|
Loading…
Reference in New Issue