-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
146 lines (84 loc) · 3.3 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
KRoC -- Source Distribution
===========================
Prerequisites
-------------
To compile and use KRoC, you will need to have the following already
installed on your machine:
- the bash shell
- the GNU toolchain -- i.e. GCC 2.95.2 or later, binutils 2.0 or later,
GNU awk, GNU make
- pkg-config
- the C development headers
- Python 2.4 or later
- xsltproc
Some occam-pi modules can optionally make use of other native libraries
if available:
- libpng
- SDL and SDL_Sound
- OpenGL
- MySQL
- Player
To check out and update KRoC from the Subversion repository, you will
also need:
- Subversion
- automake 1.8 or later, autoconf 2.52 or later (but not autoconf 2.64,
which is buggy)
On Debian-based systems, we suggest installing the following packages:
bash gcc binutils gawk make automake autoconf pkg-config
libc6-dev libsdl1.2-dev libsdl-sound1.2-dev libgl1-mesa-dev
libmysqlclient15-dev libpng12-dev libxmu-dev libxi-dev
libplayercore2-dev libplayerc2-dev libltdl3-dev
perl python xsltproc subversion
On x86-64 Debian systems, you will also need the packages that allow
32-bit binaries to be compiled:
libc6-dev-i386 lib32gcc1 gcc-multilib
Installation
------------
For installation instructions, please see:
http://projects.cs.kent.ac.uk/projects/kroc/trac/wiki/Installation
Configuration
-------------
Before using KRoC, remember to source the relevant setup file:
- ". PREFIX/bin/kroc-setup.sh" for Bourne-style shells such as bash
- "source PREFIX/bin/kroc-setup.csh" for C-style shells such as csh/tcsh
It may be convenient to include this command in your shell's startup
file (e.g. "~/.bash_profile", "~/.cshrc", or "/etc/profile").
Directories
-----------
demos/
Some standalone demo programs written in occam-pi.
doc/
Various items of documentation. The "essentially-kroc.txt" file is a
good place to start.
install/
This is the default installation directory for KRoC.
modules/
Reusable modules that can be used in occam-pi programs. Each module
contains a "libsrc" directory with the module's source code, and an
"examples" directory with demonstration and test programs.
The "modules/course" directory will probably be of particular
interest, since it contains the examples and exercises used to teach
occam-pi at the University of Kent.
runtime/
Low-level runtime support code for the occam-pi environment.
tests/
Functional test programs for occam-pi systems.
tools/
Tools for compiling, debugging, packaging and documenting occam-pi
programs.
licenses/
Copies of relevant software licenses (see Licensing below).
Note: most directories contain further README files.
Licensing
---------
KRoC is free software. In general, tools are made available under the
GNU General Public License (v2 or later), and libraries are made
available under the GNU Lesser General Public License (v2 or later).
Information about the GNU licenses can be found at:
http://www.fsf.org/licensing/
Reporting problems
------------------
Known bugs are given in the top-level BUGS file. If KRoC fails to
compile or work correctly on your system, please mail our bug tracking
system at <[email protected]>, including a brief description of the
problem and a copy of the "typescript" file generated by "build".