X-Git-Url: http://git.megacz.com/?p=org.ibex.core.git;a=blobdiff_plain;f=src%2Forg%2Fibex%2Fplat%2Fpackage.html;fp=src%2Forg%2Fibex%2Fplat%2Fpackage.html;h=a539002f71d7be6914ec647585c286c34205d2a1;hp=0000000000000000000000000000000000000000;hb=3591b88b94a6bb378af3d4abe6eb5233ce583104;hpb=de378041d5ca2aca1a2b5a31ef15ae90a86c977f
diff --git a/src/org/ibex/plat/package.html b/src/org/ibex/plat/package.html
new file mode 100644
index 0000000..a539002
--- /dev/null
+++ b/src/org/ibex/plat/package.html
@@ -0,0 +1,41 @@
+
+
+
+Each platform which Ibex is ported to should have a subclass of {@link
+org.ibex.Platform} in this package as well as an ant buildfile.
+
+
+
+The subclass of {@link org.ibex.Platform} should be named
+plat.java, where plat is the descriptive name for the
+platform. The ant buildfile should be named plat.xml, and
+should contain three targets:
+
+
+- build: compiles all code required for the Ibex
+ Engine and creates an executable in
+ ibex/www/html/dist/. If applicable, all debugging
+ symbols should be left in this executable.
+
+
- run: runs the executable, loading the
+ org.ibex.demo.main widget demo. This is useful for
+ testing.
+
+
- dist: prepares any files required to
+ distribute the engine (for example, a jar or cab). This step
+ should remove debugging symbols, if applicable.
+
+
+
+Other platform-specific files can be included in this directory, as
+long as they share the same filename as the main class, and differ
+only in extension (for example, plat.cc).
+
+
+
+Classes in this package may subclass each other; this is useful when
+two classes are very similar -- they can share a superclass containing
+the common functionality.
+
+
+