forked from processing/processing-library-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
102 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,8 +1,6 @@ | |||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<classpath> | <classpath> | ||
<classpathentry kind="src" output="bin" path="src"/> | <classpathentry kind="src" output="bin" path="src"/> | ||
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jdk1.6.0"/> | <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/> | ||
<classpathentry combineaccessrules="false" kind="src" path="/processing-core"/> | |||
<classpathentry kind="lib" path="/home/nico/workspace/libs/processing2/core.jar"/> | |||
<classpathentry kind="output" path="resources/code"/> | <classpathentry kind="output" path="resources/code"/> | ||
</classpath> | </classpath> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1 +1,3 @@ | |||
bin | |||
tmp | |||
distribution | distribution |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,7 +1,7 @@ | |||
the data folder: | the data folder: | ||
If your library is using files like images, sound files, | If your Library is using files like images, sound files, | ||
any data file, etc., put them into the data folder. | any data file, etc., put them into the data folder. | ||
When coding your library you can use processing's internal loading | When coding your Library you can use processing's internal loading | ||
functions like loadImage(), loadStrings(), etc. to load files | functions like loadImage(), loadStrings(), etc. to load files | ||
located inside the data folder into your library. | located inside the data folder into your Library. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,20 +1,18 @@ | |||
A code template to build libraries for the Processing programming environment. | A template to build a Library for the Processing programming environment. | ||
|
|
||
Part of the Processing project - http://processing.org | Part of the Processing project - http://processing.org | ||
|
|
||
Copyright (c) 2011-12 Elie Zananiri | Copyright 2011-2015 Elie Zananiri | ||
Copyright (c) 2008-11 Andreas Schlegel | Copyright 2008-2011 Andreas Shlegel | ||
|
|
||
This program is free software; you can redistribute it and/or | Licensed under the Apache License, Version 2.0 (the "License"); | ||
modify it under the terms of the GNU General Public License | you may not use this file except in compliance with the License. | ||
as published by the Free Software Foundation; either version 2 | You may obtain a copy of the License at | ||
of the License, or (at your option) any later version. | |||
|
|
||
This program is distributed in the hope that it will be useful, | http://www.apache.org/licenses/LICENSE-2.0 | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
GNU General Public License for more details. | |||
|
|
||
You should have received a copy of the GNU General Public License | Unless required by applicable law or agreed to in writing, software | ||
along with this program; if not, write to the Free Software | distributed under the License is distributed on an "AS IS" BASIS, | ||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | |||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -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##). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,49 +1,57 @@ | |||
# More on this file here: https://github.com/processing/processing/wiki/Library-Basics | # More on this file here: https://github.com/processing/processing/wiki/Library-Basics | ||
# UTF-8 supported. | # UTF-8 supported. | ||
|
|
||
# The name of your library as you want it formatted. | # The name of your Library as you want it formatted. | ||
name = ##library.name## | name = ##library.name## | ||
|
|
||
# List of authors. Links can be provided using the syntax [author name](url). | # List of authors. Links can be provided using the syntax [author name](url). | ||
authorList = [##author.name##](##author.url##) | authors = [##author.name##](##author.url##) | ||
|
|
||
# A web page for your library, NOT a direct link to where to download it. | # A web page for your Library, NOT a direct link to where to download it. | ||
url = ##library.url## | url = ##library.url## | ||
|
|
||
# The category of your library, must be one (or many) of the following: | # The category (or categories) of your Library, must be from the following list: | ||
# "3D" "Animation" "Compilations" "Data" | # "3D" "Animation" "Compilations" "Data" | ||
# "Fabrication" "Geometry" "GUI" "Hardware" | # "Fabrication" "Geometry" "GUI" "Hardware" | ||
# "I/O" "Language" "Math" "Simulation" | # "I/O" "Language" "Math" "Simulation" | ||
# "Sound" "Utilities" "Typography" "Video & Vision" | # "Sound" "Utilities" "Typography" "Video & Vision" | ||
# | # | ||
# If a value other than those listed is used, your library will listed as | # If a value other than those listed is used, your Library will listed as | ||
# "Other". | # "Other". Many categories must be comma-separated. | ||
category = ##library.category## | categories = ##library.categories## | ||
|
|
||
# A short sentence (or fragment) to summarize the library's function. This will | # 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 | # 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 | # 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 | # like mentioning that it's a Library. This should start with a capitalized | ||
# letter, and end with a period. | # letter, and end with a period. | ||
sentence = ##library.sentence## | sentence = ##library.sentence## | ||
|
|
||
# Additional information suitable for the Processing website. The value of | # Additional information suitable for the Processing website. The value of | ||
# 'sentence' always will be prepended, so you should start by writing the | # '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. | # mention it here. | ||
paragraph = ##library.paragraph## | paragraph = ##library.paragraph## | ||
|
|
||
# Links in the 'sentence' and 'paragraph' attributes can be inserted using the | # Links in the 'sentence' and 'paragraph' attributes can be inserted using the | ||
# same syntax as for authors. | # same syntax as for authors. | ||
# That is, [here is a link to Processing](http://processing.org/) | # That is, [here is a link to Processing](http://processing.org/) | ||
|
|
||
|
|||
# A version number that increments once with each release. This is used to | # A version number that increments once with each release. This is used to | ||
# compare different versions of the same library, and check if an update is | # compare different versions of the same Library, and check if an update is | ||
# available. You should think of it as a counter, counting the total number of | # available. You should think of it as a counter, counting the total number of | ||
# releases you've had. | # releases you've had. | ||
version = ##library.version## # This must be parsable as an int | version = ##library.version## # This must be parsable as an int | ||
|
|
||
# The version as the user will see it. If blank, the version attribute will be | # The version as the user will see it. If blank, the version attribute will be | ||
# used here. | # used here. This should be a single word, with no spaces. | ||
prettyVersion = ##library.prettyVersion## # This is treated as a String | prettyVersion = ##library.prettyVersion## # This is treated as a String | ||
|
|||
# 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. | |||
minRevision = ##compatible.minRevision## | |||
maxRevision = ##compatible.maxRevision## |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters