blob: f1afeb270dea847ff00b1aae82643f2fef8ad5f6 [file] [log] [blame]
<html>
<head>
<title> PLEXI DEVELOPER QUICK START </title>
</head>
<body>
<center>
<h1>
PLEXI DEVELOPER QUICK START
</h1>
A guide to becoming a developer on the Plexi project using NetBeans IDE
</center>
<br>
<p>1. Open NetBeans IDE. Here is pic of NetBeans 7.1.1 open
with no projects nor files.<br>
<img src=1.jpg>
<p>2. Click "Team -> Git -> Clone".<br>
<img src=2.jpg>
<p>3. Insert repository URL https://code.google.com/p/plexi/ .
Optionally insert username and password (if you're going
to be commiting changes).<br>
<img src=3.jpg><br>
Click Next
<p>4. Select master* branch.<br>
<img src=4.jpg><br>
Click Next
<p>5. Choose and specify your own parent directory
for projects and your own clone name. The
parent directory is where your NetBeans projects
live. The clone directory will be a subdirectory
devoted to this project.<br>
<img src=5.jpg><br>
Click Finish
<p>6. You'll be asked if you'd like to create an IDE project.
Click Create Project.<br>
<img src=6.jpg>
<p>7. Choose "Java Free-Form Project".<br>
<img src=7.jpg>
<p>8. Use parent directory and clone name as location.
Other entries should be automatically filled.<br>
<img src=8.jpg><br>
Click Next
<p>9. The Build and Run Actions should all
be automatically correctly filled.<br>
<img src=9.jpg><br>
Click Next
<p>10. Make sure to provide src directory as
source folder and test directory as tests folder.
Set source level to JDK 1.6 and encoding to UTF-8.<br>
<img src=10.jpg><br>
Click Next
<p>11. To get IDE to help with code completion, suggestions, warnings, etc. please
add all files under lib directory to src classpath.<br>
<img src=11.jpg><br>
<p>12.To get IDE to help with code completion etc. in test code please
add all files under lib directory to test classpath. Also add the src
directory to test classpath.<br>
<img src=12.jpg><br>
Click Next
<p>13.Set build/src as src class output directory (which doesn't
exist yet because we haven't compiled yet). <br>
Set build/test as test class output directory (not pictured).<br>
Also set build/javadoc as javadoc output directory.<br>
<img src=13.jpg><br>
Click Finish
<p>14. Click "Run > Test Project (plexi)" to confirm
everything compiles and all tests are passing.<br>
<img src=14.jpg width=1037>
<p>15. Congratulate yourself on setting up NetBeans
for your Plexi development!<br>
<br>
Thank you.<br>
<p>
Developers contributing source code changes should
also update source code formating rules. Stay tuned for
a visual guide on how to do that in NetBeans in the next episode.
<br>
<p>
2012.03.14<br>
California, USA<br>
</body>
</html>