
------------------------------------------------------------------------------
   _      _    _    _     _   _____    _____    ______         _  ______
  | \    / |  | |  | |   | | |  __ \  | ____|  |  ____| /\    / /|  ____|
  |  \  /  |  |_|  | \   | | | |  \ \ ||       | |      \ \  / / | |
  | \ \/ / |   _   |  \  | | | |   \| ||_____  | |       \ \/ /  | |
  | |\  /| |  | |  | \ \ | | | |   || |_____ | | |__      \  /   | |__
  | | \/ | |  | |  | |\ \| | | |   ||       || |  __|     / /    |  __|
  | |    | |  | |  | | \ \ | | |   ||       || | |       / /     | | 
  | |    | |  | |  | |  \  | | |   ||       || | |      / /      | |
  | |    | |  | |  | |   \ | | |__/ /  _____|| | |____ / /       | |_____
  |_|    |_|  |_|  |_|   |_| |_____/  |______| |______|\/        |_______|


                         We even render ascii !!!

------------------------------------------------------------------------------
       MindsEye is available in Dolby Surround [)(] in selected theatres
                Focal Point ((())) effects, only where available
------------------------------------------------------------------------------

These are the release notes for MindsEye v0.5.38

The release date of this version is (month) (day)st 2001.

Version 0.5.38 is the second release not reviewed by one of the original
authors, so please mail us if you have ideas of how the distribution or
the software itself could be improved.
The changes from 0.5.37 are minor but I hope installation is a _little_ easier
now.

------------------------------------------------------------------------------


                            README file for MindsEye
                            ======================== 


1. What is MindsEye
2. Status of the project
3. Building MindsEye
  3.1 Check the requirements:
  3.2 Compiling the package
  3.3 Making the documentation
  3.4 Installing MindsEye
  3.5 system specific notes
4. Development notes
5. Disclaimer

------------------------------------------------------------------------------


                             1 What is MindsEye
                             ==================

MindsEye is a project to develop a Free Software (in terms of the GPL)
3d modeling and animation program. Our first target ist Linux and
other UNIX systems. A port to other system may be possible.

It is sofar tested on:
	Linux, using gcc 2.95.2
	If you have been successful at building MindsEye on non-Linux
	systems, please submit a note to ainvar@users.sourceforge.net

For further information see the MindsEye WWW page at:
	http://mindseye.sourceforge.net
our check out our project page at sourceforge:
	http://sourceforge.net/projects/mindseye/

Why was this project started?
 - concentrate on the needs of the user
 - because of the gpled source code MindsEye can
   evolve into a state of the art modeling and animation package



                          2 Status of the project
                          =======================

MindsEye is not yet a real program. No part of the code should be
considered stable.



                            3 Building MindsEye
                            ===================



                        3.1 Check the requirements:
                        ---------------------------

- qt version 2.2 or higher (qt 3.x recommended)
- libqgl. This lib is part of the qt toolkit.
- OpenGL or Mesa (Version 2.2 or higher)
- gmake
- doxygen if you want to change the documentation
  (not nessecary for the program)
- About 30Mb free diskspace for a full build (with debug info)



                         3.2 Compiling the package - for this CVS snapshot
                         -------------------------

To compile the MindsEye program you have to do the following:

1. unpack the source distributon and cd into the directory MindsEye

2. get the latest nurbs++ library. Build and install it like any library.
	see the file README.nurbs

3. Run configure with the prefix for the nurbs and other options suitable 
   for your environment. There might be other configure programs
   lying around so it's safe to do a :

   	./configure 

	use --with-NURBS-prefix=DIR if your nurbs is not in /usr/local

6. Run
	make mindseye

7. The program MindsEye will be in the directory src, ready to run.




                        3.3 Making the documentation
                        ----------------------------

An archive of the documentation will be available as a separate archive.
This archive is called mindseye-doc-0.5.38.tar.gz, corresponding to this
release.

Until this documentation is available as a seperate package you can
build the class documentation using the command:

  doxygen Doxyfile

Configure Doxyfile appropriately if you want to build other formats then html.

Outdated documentation can also be viewed on our homepage.

The instructions below will no longer work but are still implemented
for future use.

to make all types of documentation, just type:

 make doc-all

to create the online html version type:

 make doc-html

to create the latex type documentation, type:

 make doc-tex

and finally, if you want the printed stuff in postscript format, type:

 make doc-ps

-----------------------------------------------------------------------

                         3.4 Installing MindsEye
                         -----------------------


No install, yet. You can start the program from the MindsEye
directory.


-----------------------------------------------------------------------

			3.5 system specifig notes
			-------------------------

Dec alpha with OSF/1 3.2:
Use gcc and gmake. Configure may fail with the standard sh. Use
ksh or bash instead.

Please report problems or submit hints which could be useful for other users.


-----------------------------------------------------------------------


                          4. Development notes
                          ====================



Directory doc contains documentation. Up to date versions can be
found on the WWW Page of the MindsEye project.

Directory icons contains some icons.

Directory libs contains libraries written by other people (not
specifically for MindsEye). The librariess won't be compiled
automatically. (Update: There is no such directory currently as it was mainly
used when the NURBS++ package was included)

Directory src contains the source code of MindsEye.

Directory test will contain some 3D data in various file formats.
(Update: This will likely be called "testfiles", not "test")

Directory textures will contain some pictures which can be used as
backgrounds or textures.

PLEASE edit the ./src/include/version.h file if you have made some
major changes and want to change the global version reported by
MindsEye

If you are interested you can join our mailing lists. Information is avilable
from the mindseye project page at sourceforge: 

	http://sourceforge.net/projects/mindseye/

We're always looking for new developers :)


                              5. Disclaimer
                              =============


We can not be held responsible for personal taste. This personal taste is
provided "AS IS" and so we cannot be held responsible for it... You can
modify and change the personal taste in the context of your own taste.
Any modification must be reported to the original owner of the personal
taste.


                                 *GRINS*
