Merge branch 'master' of https://github.com/michaelzangl/josm-plugin-opengl

Author: Michael Zangl

README.md

@@ -4,15 +4,15 @@ This is a josm plugin that replaces the default, Java2D map view with a version
 
 ## Installing
 
-There is no pre-build JAR file yet.
+See [Releases](https://github.com/michaelzangl/josm-plugin-opengl/releases)
 
 ## Compiling
 
 For this plugin, you need a special version of JOSM and of GLG2D. For the ease of compiling, GLG2D is just added to the plugin by a symbilic link, so you need Linux to compile this.
 
 Check out those repositories in the same directory:
 * https://github.com/michaelzangl/josm-plugin-opengl
-* https://github.com/michaelzangl/josm (JOSM with changes for this plugin).
+* https://github.com/openstreetmap/josm (JOSM with changes for this plugin).
 * https://github.com/michaelzangl/glg2d (Bug fixes for GLG2D)
 
 Then run:
@@ -22,3 +22,13 @@ Then run:
 ## Developing
 
 I use eclipse for developing. Simply add josm and josm-plugin-opengl as eclipse projects.
+
+All classes have Javadocs. Those are the most important entry points to get started:
+* OpenGLViewPlugin is the main entry point for the plugin.
+* MapPanel is the OpenGL-replacement of the MapView
+* LayerDrawManager does the layer drawing and replaces MapView#paint()
+* StyleGenerationManager generates the styles and geometries for the current frame and - in a background thread - for future frames.
+* StyleGeometryCache stores the geometries generated and handles invalidation.
+* MergeGroup contains an explonation of the way geometries are stored.
+* RecordingGraphics2D is our Graphics2D instance that records all draw calls and stores them for later use.
+* the SimpeBuferPool pools our vertex buffers to avoid many allocate()-calls.