|
Guidelines
Guidelines for a library contribution.
Featured Guidelines for a library contributionTo develop a library for Processing, the library template project provides an Eclipse template. Please inform us about the existence of your library by posting your contribution in the discourse section under "Libraries, Tool Development". Be sure to let us know where we can find the library's web page online. more information about developing a library can be found at dev.processing.org/libraries. Each library contribution should include the following:
Libraries should be distributed as zipped files, and the distribution should be laid out as follows:
The "reference" folder contains the documentation in HTML format as generated from Javadoc, the "examples" folder contains a set of sketches that help to understand the usage and functionality of the library. The "library" only contains the library's jar file (and if necessary, any additional jar, dll, so, or jnilib files). Anything that is found inside the "library" folder will be exported with your sketch. The "src" folder contains the source. The name src is used because that's the default for Eclipse (and presumably other IDEs). Following the folder structure is important because it simplifies documentation, and makes it easier for users to know what to expect. It also means that your reference pages can automatically be added to the Help menu in the PDE, and your library examples will automatically be added to the Examples menu. By placing your library in a .zip file and following the structure above, it enables future possibilities for automatic installation and library updates. For Mac OS X users: Be sure to remove .DS_Store files created by Mac OS X from the folders before posting. The following command can be executed in Terminal.app to delete all .DS_Store files (recursively) from a folder: find YourFolderName -name .DS_Store -ls -exec rm {} \; Be careful to specify your folder name properly. Don't use / or something that would cause the very powerful, very efficient 'find' command to remove all .DS_Store files from your disk. |