(****************************************************************** [LibNN - Neural Networks Library] http://libnn.org Copyright (C) 2002 - 2003 LAGACHERIE Matthieu RICORDEAU Olivier This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. SPECIAL NOTE (the beerware clause): This software is free software. However, it also falls under the beerware special category. That is, if you find this software useful, or use it every day, or want to grant us for our modest contribution to the free software community, feel free to send us a beer from one of your local brewery. Our preference goes to Belgium abbey beers and irish stout (Guiness for strength!), but we like to try new stuffs. Authors: LAGACHERIE Matthieu Paper mail : 7 rue Delescluzes 94280 LE KREMLIN BICETRE, FRANCE E-mail : matthieu@libnn.org RICORDEAU Olivier Paper mail : 69 avenue d'Italie 75013 PARIS, FRANCE E-mail : olivier@libnn.org *****************************************************************) /---------------------------------------------\ | Installing LibNN on your operating system | \---------------------------------------------/ If you want to compile LibNN, just do the following: Before anything else, you must use the bootstrap script in order to prepare the sources (create the configure script and the Makefile's): olivier@freedom libnn > ./bootstrap.sh If this didn't work, you can't go any further. (* LIBRARY COMPILATION *) -> REQUIRES: * the `pxp' library (`apt-get install libpxp-ocaml-dev'). Sources available here: http://ocaml-programming.de/programming/pxp.html Then, if you want to compile the LibNN library (optimized code and bytecode, depending on what can be done on your operating system): olivier@freedom libnn > make olivier@freedom libnn > ls -l libnn.* (* SOURCE CODE DOCUMENTATION *) -> Generating the sourcecode documentation: The LibNN sources set can generate source code documentation in various output formats: man, tex, dvi, pdf, ps, texi and html. If you got some weird warnings while executing the configure script, some output formats will probably be unavailable. This command will try to generate as much output formats as possible depending on what can be done on your operating system: olivier@freedom libnn > make doc -> Viewing the source code documentation: You can try to view the different output formats (each command will succeed only if the corresponding output format was successfully generated during the previous step). Just use the provided html page: doc/index.html. (* SUPPORTED ARCHITECTURES / OPERATING SYSTEMS *) We plan to make our sources compilable on as much architectures as possible. If you need an architecture to be supported, just send an email to the authors (see this file's header). An ssh access to a machine running the architecture you need to be supported would be really helpful. LibNN is mainly developed on Debian GNU/Linux. We hope you enjoy LibNN! Cheers, -= The LibNN development team =-