Read Me

=== PHDL SVN Repository ===
Contributors: briching (Brad Riching), joshuagm (Joshua Mangelson)
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

== Description ==

PHDL (PCB Hardware Description Language) is a new hardware description language designed 
to capture connectivity of a PCB (Printed Circuit Board).  The language and compiler are used
in lieu of the conventional first step of PCB design, which is graphical schematic capture.
Instead, the connectivity is captured with plain text source files which are compiled and
elaborated into a flattened netlist which is imported into typical back-end layout tools.

PHDL is NOT a layout tool.  It only takes the place of the first step in PCB design--capturing
the connectivity with a schematic.

== Repository structure ==

The repository consists of the following folder structure:
	/svnroot/phdl
		/branches	(Release branches of the form RB-X.x, where X.x indicate Major.minor revisions)
		/tags		(Hardened releases of the form REL-X.x.x where X.x.x indicate Major.minor.micro revisions)
		/trunk		(Location of main project development)
	
The /tags folder is not intended to be used for active development.  The /branches folder is intended
to be used for experimental or bug-fixes in the development process.  Most users should only check out the
releases in the /tags folder.  Both /branches and /tags contain only snapshots of the development code
from the /trunk folder.

Inside /trunk exists:
		/phdl-2.0	(2.0 standalone version of the compiler tool)
		/misc			(miscellaneous project materials)
		/phdl-2.1		(2.x Eclipse plugin and standalone version of the tool-slated for July 1, 2012 release)
		/utils			(utilities which aid in the automatic generation of certain PHDL constructs)
	
Inside /phdl-2.0 exists:
		/doc	(Javadoc project documentation)
		/jar	(Jar dependencies)
		/src	(project source code)
		/xml	(XML converter utility (deprecated))

Inside /phdl-2.1 exists:
		/xtext	(xtext core project)
		/tests	(JUnit test cases)
		/ui	(plug-in user interface)
		/log4j	(log4j configuration and properties)
		/feature(the feature set that bundles the plug-in for release)
		/update	(the update site generated for the feature project)

== Installation ==

Please refer to http://phdl.sourceforge.net for details on installation and further documentation.