blob: e3b3fb7dfdf09c22e53eb559622ef87cc9d9e60d [file] [log] [blame]
***** THIS MOST IMPORTANT FILE IN THIS PROJECT IS *****
***** *****
***** dev-guide/dev-guide.pdf *****
***** *****
***** IF YOU ARE LOOKING FOR DEVELOPER *****
***** DOCUMENTATION, START THERE. *****
Contents of this project:
dev-guide/
Contains the Photran Developer's Guide. The Git
instructions in Appendix A are also made into a
separate PDF.
Run Ant on build.xml to build the documentation
using pdflatex. (In Eclipse, right-click build.xml
and click on Run As > Ant Build.)
misc-notes/
Various notes-to-self that aren't import enough to
be in the Developer's Guide.
contributions/
Contains correspondence and documentation related to
third-party contributions in Photran.
eclipse-config/
Contains settings for the Eclipse Java code formatter
and code templates. These have since been hard-coded
into the settings for each project, so they will be
applied by default when code is formatted or new classes
are created.
--Jeff Overbey 8/19/05, updated 8/29/08, 11/12/09, 11/02/11