|
GettingStarted
InstallationFirst, you need to install PLURAL. The installation instructions are described on the Installation page. You will also need the PLURAL annotations jar or project in whichever workspace you will be using PLURAL. Those instructions are on the Annotations page. ExamplesCurrently, documentation on PLURAL is lacking. This is a known issue. So the best way to get started is to check out the PLURAL test project, run PLURAL on the tests to see if your installation worked, and examine the test files to see how the annotations are used in practice. PLURAL Test ProjectThe PLURAL test project is also located inside the source repository. It's at the top level of the trunk (here). You should check this project out into the workspace where you plan to use PLURAL. Run PLURAL on the Test FilesThe PLURAL tests work like all Crystal tests. This procedure is described here. Unfortunately, the automated testing procedure only works if you have checked PLURAL and Crystal out from source. If not, you can still run PLURAL by hand:
Examining the Test FilesThere are a number of simple and complex examples of the use of PLURAL contained in the test project. A good starting point is the Conslist example, which defines a very simple protocol, and is defined to be immutable. |