updated to latest format of library template

Author: codeanticode

resources/README.md

@@ -0,0 +1,38 @@
+## How to install ##library.name##
+
+### Install with the Contribution Manager
+
+Add contributed Libraries by selecting the menu item _Sketch_ → _Import Library..._ → _Add Library..._ This will open the Contribution Manager, where you can browse for ##library.name##, or any other Library you want to install.
+
+Not all available Libraries have been converted to show up in this menu. If a Library isn't there, it will need to be installed manually by following the instructions below.
+
+### Manual Install
+
+Contributed Libraries may be downloaded separately and manually placed within the `libraries` folder of your Processing sketchbook. To find (and change) the Processing sketchbook location on your computer, open the Preferences window from the Processing application (PDE) and look for the "Sketchbook location" item at the top.
+
+By default the following locations are used for your sketchbook folder: 
+  * For Mac users, the sketchbook folder is located inside `~/Documents/Processing` 
+  * For Windows users, the sketchbook folder is located inside `My Documents/Processing`
+
+Download ##library.name## from ##library.url##
+
+Unzip and copy the contributed Library's folder into the `libraries` folder in the Processing sketchbook. You will need to create this `libraries` folder if it does not exist.
+
+The folder structure for Library ##library.name## should be as follows:
+
+```
+Processing
+  libraries
+    ##library.name##
+      examples
+      library
+        ##library.name##.jar
+      reference
+      src
+```
+             
+Some folders like `examples` or `src` might be missing. After Library ##library.name## has been successfully installed, restart the Processing application.
+
+### Troubleshooting
+
+If you're having trouble, have a look at the [Processing Wiki](https://github.com/processing/processing/wiki/How-to-Install-a-Contributed-Library) for more information, or contact the author [##author.name##](##author.url##).

resources/build.properties

@@ -1,80 +1,69 @@
-# Create libraries for the Processing open source programming language and 
-# environment (http://www.processing.org)
+# Create a Library for the Processing open source programming language and 
+# environment (http://processing.org/)
 #
 # Customize the build properties to make the ant-build-process work for your 
 # environment. How? Please read the comments below.
 #
-# The default properties are set for OSX, for Windows-settings please refer to 
-# comments made under (1) and (2).
+# The default properties are set for OS X. Please refer to comments for Windows
+# settings.
 
 
-
-# (1) 
 # Where is your Processing sketchbook located? 
 # If you are not sure, check the sketchbook location in your Processing 
 # application preferences.
 # ${user.home} points the compiler to your home directory.
 # For windows the default path to your sketchbook would be
-# ${user.home}/My Documents/Processing (make adjustments below).
+# ${user.home}/My Documents/Processing (make adjustments below)
 
+#sketchbook.location=${user.home}/My Documents/Processing
 sketchbook.location=${user.home}/code/processing/sketchbook
 
 
-
-# (2) 
-# Where are the jar files located that are required for compiling your library 
+# Where are the jar files located that are required for compiling your Library 
 # such as e.g. core.jar?
 # By default the local classpath location points to folder libs inside Eclipse's
 # workspace (by default found in your home directory).
-# For Windows the default path would be ${user.home}/workspace/libs (make 
-# adjustments below).
+# For Windows, the default path would be
+# ${user.home}/Documents/workspace/libs (make adjustments below)
+# For OS X,the following path will direct you into Processing's application
+# package, in case you put Processing inside your Applications folder. 
 
 #classpath.local.location=${user.home}/Documents/workspace/libs
-
-
-# For OSX users. 
-# The following path will direct you into Processing's application source code 
-# folder in case you put Processing inside your Applications folder. 
-# Uncommenting the line below will overwrite the classpath.local.location from 
-# above.
-
-classpath.local.location=${user.home}/code/processing/git/processing/build/macosx/work/Processing.app/Contents/Java/core/library
+classpath.local.location=/Applications/Processing.app/Contents/Java/core/library
 
 
 # Add all jar files that are required for compiling your project to the local 
-# and project classpath, use a comma as delimiter. These jar files must be 
+# and project classpath. Use a comma as delimiter. These jar files must be 
 # inside your classpath.local.location folder.
 
 classpath.local.include=core.jar
 
 
-# Add processing's libraries folder to the classpath.
+# Add Processing's libraries folder to the classpath.
 # If you don't need to include the libraries folder to your classpath, comment 
 # out the following line.
 
 classpath.libraries.location=${sketchbook.location}/libraries
 
 
+# Set the java version that should be used to compile your Library.
 
-# (3)
-# Set the java version that should be used to compile your library.
-
-java.target.version=1.6
+java.target.version=1.8
 
 
 # Set the description of the Ant build.xml file.
 
-ant.description=ProcessingLibs Ant build file.
+ant.description=Processing Library Ant build file.
 
 
-
-# (4)
-# Project details.
-# Give your library a name. The name must not contain spaces or special characters.
+# Give your Library a name. The name must not contain spaces or special 
+# characters.
 
 project.name=planetarium
 
-# The name as the user will see it. This can contain spaces and special characters.
+
+# The name as the user will see it. This can contain spaces and special 
+# characters.
 
 project.prettyName=planetarium
 
@@ -83,89 +72,101 @@ project.prettyName=planetarium
 # 'fast' will only compile the project into your sketchbook.
 # 'normal' will compile the distribution including the javadoc-reference and all
 # web-files (the compile process here takes longer).
+# All files compiled with project.compile=normal are stored in the distribution 
+# folder.
 
 project.compile=normal
 
-# All files compiled with project.compile=normal are stored 
-# in the distribution folder.
 
-
-
-# (5)
-# The following items are properties that will be used to make changes to the 
-# web document templates. Values of properties will be inserted into the 
-# documents automatically.
-# If you need more control, you can edit web/index.html and
-# web/library.properties directly.
+# Set your name and URL, used for the web page and properties file.
 
 author.name=Andres Colubri
 author.url=http://andrescolubri.net/
 
 
-# Set the web page for your library.
+# Set the web page for your Library.
 # This is NOT a direct link to where to download it.
 
 library.url=https://github.com/codeanticode/planetarium
 
 
-# Set the category of your library. This must be one (or many) of the following:
+# Set the category (or categories) of your Library from the following list:
 #   "3D"            "Animation"     "Compilations"      "Data"          
 #   "Fabrication"   "Geometry"      "GUI"               "Hardware"      
 #   "I/O"           "Language"      "Math"              "Simulation"    
-#   "Sound"         "Utilities"     "Typography"        "Video & Vision"  
-# If a value other than those listed is used, your library will listed as 
-# "Other".
+#   "Sound"         "Utilities"     "Typography"        "Video & Vision"
+# 
+# If a value other than those listed is used, your Library will listed as 
+# "Other". Many categories must be comma-separated.
 
 library.category=3D
 
 
-# A short sentence (or fragment) to summarize the library's function. This will 
-# be shown from inside the PDE when the library is being installed. Avoid 
-# repeating the name of your library here. Also, avoid saying anything redundant 
-# like mentioning that it's a library. This should start with a capitalized 
+# A short sentence (or fragment) to summarize the Library's function. This will 
+# be shown from inside the PDE when the Library is being installed. Avoid 
+# repeating the name of your Library here. Also, avoid saying anything redundant 
+# like mentioning that it's a Library. This should start with a capitalized 
 # letter, and end with a period.
 
 library.sentence=This library provides a renderer to project 3D scenes on a full dome.
 
 
 # Additional information suitable for the Processing website. The value of
 # 'sentence' always will be prepended, so you should start by writing the
-# second sentence here. If your library only works on certain operating systems,
+# second sentence here. If your Library only works on certain operating systems,
 # mention it here.
 
 library.paragraph=It works by rendering the scene 5 times (one from each direction: top, right, etc) and then assembling the output of these renderings into a single environmental map that covers the entire dome.
 
 
 # Set the source code repository for your project.
-# Recommendations for storing your source code online are Google Code or GitHub.
+# We recommend Bitbucket (https://bitbucket.org) or GitHub (https://github.com).
 
 source.host=GitHub
 source.url=https://github.com/
 source.repository=https://github.com/codeanticode/planetarium
 
 
-# The current version of your library. 
+# The current version of your Library. 
 # This number must be parsable as an int. It increments once with each release. 
-# This is used to compare different versions of the same library, and check if 
+# This is used to compare different versions of the same Library, and check if 
 # an update is available.
 
 library.version=5
 
 
-# The version as the user will see it. 
+# The version as the user will see it.
 
 library.prettyVersion=0.5
 
 
-library.copyright=(c) 2013-2018
-library.dependencies=opengl
-library.keywords=dome projection,planetarium,real-time
+# The min and max revision of Processing compatible with your Library.
+# Note that these fields use the revision and not the version of Processing, 
+# parsable as an int. For example, the revision number for 2.2.1 is 227. 
+# You can find the revision numbers in the change log: https://raw.githubusercontent.com/processing/processing/master/build/shared/revisions.txt
+# Only use maxRevision (or minRevision), when your Library is known to 
+# break in a later (or earlier) release. Otherwise, use the default value 0.
+
+compatible.minRevision=0246
+compatible.maxRevision=0
+
+
+# The platforms and Processing version that the Library has been tested
+# against. This information is only used in the generated webpage.
+
+tested.platform=osx,windows
+tested.processingVersion=3.2.3
+
+
+# Additional information for the generated webpage.
 
-tested.platform=osx,windows,linux
-tested.processingVersion=3.3.6
+library.copyright=(c) 2016
+library.dependencies=?
+library.keywords=?
 
 
 # Include javadoc references into your project's javadocs.
 
-javadoc.java.href=http://java.sun.com/javase/6/docs/api/
-javadoc.processing.href=http://processing.googlecode.com/svn/trunk/processing/build/javadoc/core/
+#javadoc.java.href=http://docs.oracle.com/javase/7/docs/api/
+javadoc.java.href=http://docs.oracle.com/javase/8/docs/api/
+javadoc.processing.href=http://processing.github.io/processing-javadocs/core/

resources/build.xml

@@ -1,4 +1,4 @@
-<project name="Planetarium" default="clean" basedir="../">
+<project name="Processing Library" default="clean" basedir="../">
 
 
 <!--	
@@ -52,8 +52,8 @@
 	<property name="project.reference" location="reference"/>
 	<property name="project.dist" location="distribution"/>
 	<property name="project.dist.version" location="distribution/${project.name}-${library.version}"/>
-	<property name="install.source" location="resources/install_instructions.txt"/>
-	<property name="install.destination" location="${project.dist.version}/INSTALL.txt"/>
+	<property name="install.source" location="resources/README.md"/>
+	<property name="install.destination" location="${project.dist.version}/README.md"/>
 	<property name="libprops.source" location="resources/library.properties"/>
 
 	<taskdef resource="net/sf/antcontrib/antcontrib.properties">
@@ -78,7 +78,7 @@
 
 	<target name="init"> 
 		<echo>${line}
-    Building the Processing library ${project.name} ${library.version}
+    Building the Processing Library ${project.name} ${library.version}
 ${line}
 	src path        ${project.src}
 	bin path        ${project.bin}
@@ -209,8 +209,8 @@ ${line}
 
 
 	<target name="generate.javadoc" if="is.normal">
-	  	<!-- create the java reference of the library -->
-		<javadoc bottom="Processing library ${project.name} by ${author.name}. ${library.copyright}" 
+	  	<!-- create the java reference of the Library -->
+		<javadoc bottom="Processing Library ${project.name} by ${author.name}. ${library.copyright}" 
 				classpath="${classpath.local.location}/core.jar;{project.bin}" 
 				destdir="${project.tmp}/${project.name}/reference" 
 				verbose="false" 
@@ -271,8 +271,11 @@ ${line}
         <replaceregexp file="${file}" match="##library.version##" replace="${library.version}" flags="g" />
         <replaceregexp file="${file}" match="##library.prettyVersion##" replace="${library.prettyVersion}" flags="g" /> 
 
+        <replaceregexp file="${file}" match="##compatible.minRevision##" replace="${compatible.minRevision}" flags="g" />
+        <replaceregexp file="${file}" match="##compatible.maxRevision##" replace="${compatible.maxRevision}" flags="g" /> 
+        
         <replaceregexp file="${file}" match="##library.url##" replace="${library.url}" flags="g" />
-        <replaceregexp file="${file}" match="##library.category##" replace="${library.category}" flags="g" />
+        <replaceregexp file="${file}" match="##library.categories##" replace="${library.categories}" flags="g" />
         <replaceregexp file="${file}" match="##library.sentence##" replace="${library.sentence}" flags="g" />
     	<replaceregexp file="${file}" match="##library.paragraph##" replace="${library.paragraph}" flags="g" />
     	<replaceregexp file="${file}" match="##library.keywords##" replace="${library.keywords}" flags="g" />
@@ -289,15 +292,15 @@ ${line}
 
 
 	<target name="generate.install.library" if="is.normal">	
-		<copy file="${install.source}" tofile="${project.dist.version}/INSTALL.txt" />
+		<copy file="${install.source}" tofile="${install.destination}" />
 
 		<antcall target="parse.file"><param name="file" value="${install.destination}"/></antcall>
 	</target>	
 
 
 
 	<target name="generate.zip" if="is.normal">
-		<!-- zip the distribution of the library -->
+		<!-- zip the distribution of the Library -->
 
 		<move todir="${project.dist.version}/tmp/${project.name}">
   			<fileset dir="${project.dist.version}/${project.name}" />

resources/code/ExampleTaglet.class

@@ -1,10 +1,10 @@
 # a shell script to create a java documentation 
-# for a processing library. 
+# for a processing Library. 
 # 
 # make changes to the variables below so they 
-# fit the structure of your library
+# fit the structure of your Library
 
-# the package name of your library
+# the package name of your Library
 package=template;
 
 # source folder location