1 |
/----------------------------------\ |
(****************************************************************** |
2 |
| Installing The Marvin Project | |
[The Marvin Project] |
3 |
\----------------------------------/ |
http://marvinproject.org |
4 |
|
Copyright (C) 2002 - 2003 The Marvin Project development team: |
5 |
For now, the sourcesare not compilable, and nothing is installable |
|
6 |
since the project is in active developpement. |
* LAGACHERIE Matthieu |
7 |
|
* RICORDEAU Olivier |
8 |
Later, we plan to make our sources compilable on as much architectures |
* ROUGET Paul |
9 |
as possible. If you need an architecture to be supported, just send an |
* LEMAIRE Kevin |
10 |
email to Olivier Ricordeau (olivier.ricordeau). An ssh access to a |
* PARMANTIER Romain |
11 |
machine running the architecture you need to be supported would be |
* BOUILLET Olivier |
12 |
really helpful. |
|
13 |
|
This program is free software; you can redistribute it and/or |
14 |
|
modify it under the terms of the GNU General Public License |
15 |
|
as published by the Free Software Foundation; either version 2 |
16 |
|
of the License, or (at your option) any later version. This |
17 |
|
program is distributed in the hope that it will be useful, |
18 |
|
but WITHOUT ANY WARRANTY; without even the implied warranty of |
19 |
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
20 |
|
GNU General Public License for more details. You should have |
21 |
|
received a copy of the GNU General Public License |
22 |
|
along with this program; if not, write to the Free Software |
23 |
|
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA |
24 |
|
02111-1307, USA. |
25 |
|
|
26 |
|
(* Authors *): |
27 |
|
See the AUTHORS file for more information about the authors. |
28 |
|
|
29 |
|
* LAGACHERIE Matthieu |
30 |
|
E-mail : matthieu@marvinproject.org |
31 |
|
|
32 |
|
* RICORDEAU Olivier |
33 |
|
E-mail : olivier@marvinproject.org |
34 |
|
|
35 |
|
* ROUGET Paul |
36 |
|
E-mail : @marvinproject.org // FIXME Some info is missing here. |
37 |
|
|
38 |
|
* LEMAIRE Kevin |
39 |
|
E-mail : @marvinproject.org // FIXME Some info is missing here. |
40 |
|
|
41 |
|
* PARMANTIER Romain |
42 |
|
E-mail : @marvinproject.org // FIXME Some info is missing here. |
43 |
|
|
44 |
|
* BOUILLET Olivier |
45 |
|
E-mail : @marvinproject.org // FIXME Some info is missing here. |
46 |
|
|
47 |
|
*****************************************************************) |
48 |
|
|
49 |
|
|
50 |
|
|
51 |
|
/----------------------------------------------------------\ |
52 |
|
| Installing The Marvin Project on your operating system | |
53 |
|
\----------------------------------------------------------/ |
54 |
|
|
55 |
|
For now, only LibNN sources are compilable, and nothing is installable |
56 |
|
since the project is in active development. |
57 |
|
If you want to compile LibNN, just do the following: |
58 |
|
|
59 |
|
Before anything else, you must create the configure script and the Makefile: |
60 |
|
olivier@freedom marvin > cd src/libnn |
61 |
|
olivier@freedom libnn > autoconf && ./configure |
62 |
|
|
63 |
|
If this didn't work, you can't go any further. |
64 |
|
|
65 |
|
(* LIBRARY COMPILATION *) |
66 |
|
|
67 |
|
Then, if you want to compile the LibNN library (optimized code and bytecode, |
68 |
|
depending on what can be done on your operating system): |
69 |
|
olivier@freedom libnn > make |
70 |
|
olivier@freedom libnn > ls -l libnn.* |
71 |
|
|
72 |
|
|
73 |
|
(* SOURCE CODE DOCUMENTATION *) |
74 |
|
|
75 |
|
-> Generating the sourcecode documentation: |
76 |
|
The LibNN sources set can generate source code documentation in various output |
77 |
|
formats: man, tex, dvi, pdf, ps, texi and html. If you got some weird warnings |
78 |
|
while executing the configure script, some output formats will probably be |
79 |
|
unavailable. This command will try to generate as much output formats as |
80 |
|
possible depending on what can be done on your operating system: |
81 |
|
olivier@freedom libnn > make doc |
82 |
|
|
83 |
|
-> Viewing the source code documentation: |
84 |
|
You can try to view the different output formats (each command will succeed |
85 |
|
only if the corresponding output format was successfully generated during the |
86 |
|
previous step) |
87 |
|
|
88 |
|
* man |
89 |
|
olivier@freedom libnn > make doc-view-man |
90 |
|
* pdf (requires xpdf) |
91 |
|
olivier@freedom libnn > make doc-view-pdf |
92 |
|
* html (requires mozilla) |
93 |
|
olivier@freedom libnn > make doc-view-html |
94 |
|
* ps (requires gv) |
95 |
|
olivier@freedom libnn > make doc-view-ps |
96 |
|
|
97 |
|
* For the other formats (tex. dvi and texi), take a look around doc/libnn. |
98 |
|
|
99 |
|
|
100 |
|
(* SUPPORTED ARCHITECTURES / OPERATING SYSTEMS *) |
101 |
|
|
102 |
|
We plan to make our sources compilable on as much architectures as possible. If |
103 |
|
you need an architecture to be supported, just send an email to the authors |
104 |
|
(see this file's header). An ssh access to a machine running the architecture |
105 |
|
you need to be supported would be really helpful. |
106 |
|
|
107 |
|
The Marvin Project is developed using the following operating systems: GNU/Linux |
108 |
|
(Slackware, Mandrake, Debian, Gentoo) and NetBSD. |
109 |
|
|
110 |
|
|
111 |
|
We hope you enjoy marvin! |
112 |
|
Cheers, |
113 |
|
|
114 |
|
-= The Marvin Project development team =- |