Home

Awesome

Maven Central Javadocs

INSTALL

This repository is organized so that you can place it in a folder named minim inside of your Processing sketchbook's libraries folder.

You can accomplish this in two ways:

  1. Download the repository.
  1. Clone the repository using git.

DEVELOP

This repository is already setup as an Eclipse project. Once you have acquired a copy of the repository in one of the above two ways, you can import it into Eclipse as an existing project and browse around the source, making any changes you want. To do so you must:

You should now have a browsable project in the package explorer called 'minim' that will auto-build class files. You may encounter errors if you don't have a default JRE set in Eclipse. Make sure that you have an installed JRE by going to Preferences and looking under Java -> Installed JREs.

To build the project right-click on build.xml and choose Run As -> Ant Build. Once you do this, you can use the build in Processing immediately. It is not necessary to restart Processing after building the library. If you want local documentation, choose Run As -> Ant Build... and make sure that the 'doc' option is checked and then build the project.

CONTRIBUTE

If you'd like to contribute to the development of Minim, you will need to fork the repository on Github.

When you've made a change that you'd like to see included in the main development branch, you can send a Pull Request through Github. The Minim dev team will review your changes and accept them if they are in line with our goals and standards. If they are not, we will probably let you know why we didn't accept the Pull Request. Development of Minim is by no means a full-time endeavor, so don't be surprised if it takes us a while to review your request.

If you intend to make changes to the source that you want submit to the main development branch, please use the code_formatting_style.xml file as your Java formatting rules. To do so, you must:

If you change your Active profile, be sure to change it back to 'Minim Standards' before editing Minim source.

PUSHING (TO CLOJARS by default)

  1. Please change the groupId in pom.xml to something relevant to you
  2. Either ensure you have a properly setup SSL access to Clojars or set your preferred repo in pom.xml
  3. mvn deploy

HAVE FUN!