Skip to content

Commit 70953a3

Browse files
author
Meulemans
committed
Simplified README, now defering to Wiki
1 parent 17201c5 commit 70953a3

File tree

1 file changed

+7
-29
lines changed

1 file changed

+7
-29
lines changed

README.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,10 @@
1-
GeometryCore is a java library to quickly develop prototypes for geometric algorithms
2-
and tools. It has five primary foci
3-
4-
(1) Standalone, quick to set up and portable
5-
This library does not depend on other libraries beyond the standard java
6-
libraries. Being native java, it should readily work on most platforms.
1+
GeometryCore is a java library to quickly develop prototypes for geometric
2+
algorithms and tools.
73

8-
(2) Providing some basic functionality for working with geometric objects in 2D
9-
See the nl.tue.geometrycore.geometry package for the implementation
10-
11-
(3) Ease of setting up a GUI with some default interaction
12-
See the nl.tue.geometrycore.gui / geometryrendering packages. Most important
13-
is to extend from GeometryPanel (geometryrendering package). You can
14-
quickly create a JFrame using the function in GUIUtils (gui package).
15-
Optionally, you can also provide a TabbedSidePanel (gui package) for quickly
16-
creating a basic GUI in code.
17-
18-
(4) Ease of importing and exporting to IPE and IPE files
19-
IPEReader and IPEWriter are the main classes for this functionality
20-
(nl.tue.geometrycore.io.ipe package). Note that the constructors are static
21-
functions.
22-
23-
(5) Abstraction of rendering code from the target (GUI, IPE, SVG, PNG)
24-
The same BaseWriter (nl.tue.geometrycore.io package) is implemented for
25-
different targets (Raster images, Swing, IPE and SVG formats). See the
26-
respective subpackages. Also note that the GeometryPanel (focus 3) uses such
27-
a base writer. You can re-use the drawScene() method for other targets by
28-
creating the appropriate writer and calling render() on the GeometryPanel.
4+
It has five primary foci: (1) stand-alone and portable;
5+
(2) basic geometric objects in 2D; (3) easily set up a basic GUI; (4) ease of
6+
importing from and exporting to IPE files; (5) abstraction from rendering code
7+
between GUI and file formats.
298

30-
Beyond this core functionality, the library offers some basic implementations of
31-
graphs, data structures and algorithms.
9+
Refer to the Wiki pages on GitHub for more details and basic tutorials.
3210

0 commit comments

Comments
 (0)