Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.07 KB

README.md

File metadata and controls

56 lines (36 loc) · 2.07 KB
Raw

HYPE Processing Library

A project maintained by Joshua Davis / twitter.com/joshuadavis.

A collection of classes that performs the heavy lifting for you by writing a minimal amount of code.

www.hypeframework.org

This library is currently under heavy development. You can keep track of the latest changes here in the CHANGELOG.

Getting Started

Install to Processing Sketchbook

The HYPE library may be uzipped from the distribution folder 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 HYPE from https://github.com/hype/HYPE_Processing

Unzip and copy the HYPE 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 HYPE should be as follows:

Processing
  libraries
    HYPE
      examples
      library
        HYPE.jar
      reference
      src

After HYPE has been successfully installed, restart the Processing application.

Build Sources with ANT

Run build.xml in the Resources folder. If you're running Windows, you'll need to update 'sketchbook.location' and 'classpath.local.location' in build.properties.

The HYPE library will be added to your sketchbook folder automatically.

Documentation

TODO: Add link to Java docs here

Contributors

James Cruz, Benjamin Fox, Christopher Tino

License

HYPE is available under the BSD license. See LICENSE for full details.