Developer Guide
How to help developing Fritzing
Setting up your development environment
Get Eclipse
- Download and install the latest version of Eclipse
- Go to the eclipse download page and download the latest Eclipse for RCP/Plug-in Developers
- Unzip it to a sensible location like /Applications/Eclipse
- Start it
Get the Fritzing code
- Install the subversion client "Subclipse"
- Access the Eclipse Update Manager under Help > Software Updates > Find and Install..
- Add a new remote update site for Subclipse at http://subclipse.tigris.org/update_1.2.x
- Start the search and select and install the "Subclipse Plugin" (you don't need the "Integrations")
- Restart Eclipse
- Checkout the Fritzing source code
- Add a new project through File > New > Other.. > SVN > Checkout Projects from SVN
- Add http://fritzing.googlecode.com/svn as the SVN repository location
- Browse to /trunk/fritzing, select Fritzing and check it out as a project
- Do the same for Fritzing.diagram and Fritzing.edit
- Switch back to the Java perspective
Install the necessary Eclipse Plugins
- Go to the Eclipse Update Manager again
- This time, from the "Europa Discovery Site" you need the following:
(If any of these don't show up in the list, you probably already have them installed. In this case, you might wanna try to update them to the latest version.) - Models and Model Development
- Graphical Modeling Framework
Click on "Select Required" to resolve conflicts - Enabling Features
- EMF Validation Framework OCL Integration
- Graphical Editing Framework
- Graphical Editing Framework SDK
- Java Development
- Eclipse Plug-in Development Environment
- Install all and restart Eclipse
Building and Running
- Use the supplied product definition to run Fritzing
- Open the fritzing.product file in the root of the Fritzing project
- Under Testing, click "Launch an Eclipse application"
- ..and that should launch Fritzing
- This creates a run configuration named fritzing.product. From now on, you can use this to run Fritzing.
Submitting your Changes
For the beginning, we would be happy if you just sent us your updated files via E-Mail or add them as an attachment to the issue tracker. If you become really serious, we'll later on be happy to grant you commit rights for the repository.
Resources
Due to the super-sized frameworks we're building on, it will be helpful to do some reading. Here are some good resources to get you started:
Eclipse Beginners
RCP - Rich Client Platform
SWT - Standard Widget ToolkitEAGLE |
GMF - Graphical Modeling Framework
GEF - Graphical Editing FrameworkEMF - Eclipse Modeling Framework |
