first reimport from platal
[platal.git] / README
1 Notes for plat/al, a platform for alumni services
2
3 PRESENTATION
4 ------------
5
6 plat/al is the platform used by Polytechnique.org [1], the alumni site of
7 Ecole Polytechnique [2], France. This package is a suite of web applications
8 geared towards alumni websites. This is used to deliver services to more than
9 12.000 registered alumni on Polytechnique.org.
10
11 More information can be found on the plat/al project page [3].
12
13 [1] Polytechnique.org     http://www.polytechnique.org/
14 [2] Ecole Polytechnique   http://www.polytechnique.edu/
15 [3] plat/al project       http://opensource.polytechnique.org/platal/
16
17
18 REQUIREMENTS
19 ------------
20
21 First of all you will need a webserver. If you do not currently have a
22 webserver, you might consider taking a look at the Apache webserver :
23
24   http://httpd.apache/org/
25
26 plat/al is written in PHP so you need PHP support for your webserver. You
27 can find PHP here :
28
29   http://www.php.net/
30
31 plat/al makes use of the Smarty template engine which can be found here :
32
33   http://smarty.php.net/
34
35 plat/al also makes heavy use of the Diogenes library, libdiogenes which lives
36 here :
37
38   http://opensource.polytechnique.org/libdiogenes/
39
40 You will need to have access to a MySQL server. If you do not currently have a
41 MySQL server running, you can download it here :
42
43   http://www.mysql.com/
44
45
46 BUILDING
47 --------
48
49 To build plat/al, simply run "make" from the toplevel directory.
50