README.md 2.13 KB
Newer Older
1 2 3 4
PAKCS: The Portland Aachen Kiel Curry system
============================================

PAKCS is an implementation of the multi-paradigm declarative language
5
[Curry](http://www.curry-lang.org) developed by RWTH Aachen,
6
University of Kiel and Portland State University
7
(email contact: pakcs@curry-lang.org)
8 9 10

This directory contains:

11
`RELNOTES.txt`:
12 13 14
  Some information about the current release and changes w.r.t. previous
  releases of PAKCS.

15
`RESOURCES.html`:
16 17 18
  A description of various resources related to PAKCS and Curry.
  This is helpful for new users.

19
`INSTALL.md`:
20 21
  Instructions how to install the system.

22
`GITINSTALL.md`:
23 24
  Instructions how to install the system from the GIT repository
  (only intended for developers).
25

26 27 28
`bin`:
  A directory containing various executables
  to execute the components of PAKCS.
29

30
`src`:
31 32 33 34
  This directory contains the compiler from Curry into Prolog which
  is the basis of the main component of PAKCS: the interactive
  development environment.

35
`currytools`:
36
  This directory contains some base tools for Curry
Michael Hanus 's avatar
Michael Hanus committed
37 38
  (see the README there for a more detailed description).

39
`docs`:
40 41 42
  This directory contains some documentation (Curry Report, PAKCS User Manual,
  DTD for XML representation of FlatCurry).

43
`examples`:
44
  This directory contains a collection of example Curry programs
45 46
  and a shell script `test.sh` to test the basic functionality
  of the system.
47 48 49 50 51

`frontend`:
  This directory contains the Curry frontend, i.e., a parser for
  Curry programs. It is adapted from the parser originally developed for the
  [Muenster Curry Compiler](http://danae.uni-muenster.de/~lux/curry/).
52

53
`lib`:
54 55
  This directory contains the standard libraries of PAKCS
  (including the standard prelude).
56

57 58 59 60 61 62 63 64
`scripts`:
  This directory contains some templates for scripts used in PAKCS.

`testsuite`:
  This directory contains a collection of Curry programs
  implementing unit and property tests to check the functionality
  of the system using CurryCheck. All tests can be executed by the
  shell script `test.sh` in this directory.
65

66
`tools`:
67
  This directory contains various tools for PAKCS
68
  (see the README there for a more detailed description).