/*
 *
 * Title: README
 * Product: 3dfile v0.1.9.1
 * Author: Mircea Mitu
 * Date: January 7, 2002
 *
 */

1. Introduction

This is 3dfile v0.1.9.1, an OpenGL based (*) file browser.
It isn't a file manager! At least not yet. It's just a simple
"walk-through directories" & "executable launcher" program.
It's far to be perfect, but it can be a good start for something better.
Originally was based on 3dmenu a QT application, but now,
the only common thing is some color code.


2. Requirements

It should work (compile&run) on any Unix/X11 system or
under Win9x/NT (with some modifications I'll discuss later **).
What do you need for? Let's see:
-OpenGL libs&headers, or Mesa;
-glut;
-ANSI C compiler.
The only systems I can guarantee it works under, are:
-x86 systems
-Linux 2.2.*/2.4.* (Mandrake 8.1)
-XFree 3.3.6 / 4.0.3 (or better, 4.1 series recommended)
-Mesa 3.2 / 3.4.2 / 4.0
-glut 3.7
-egcs-2.1.1 / egcs-2.91.66 (kgcc) / gcc 2.96 / gcc 3.0.1

but I don't see why it shouldn't work on any other *nix(like) system.
It was previously testes/developed on systems with:
1. RedHat 4.2 - Mesa 3.0, Mesa 3.1 - gcc 2.7.2.1
2. RedHat 6.0 - Mesa 3.1, Mesa 3.2 - egcs-2.1.1
3. Slackware 7.1
4. Mandrake 7.1 / 8.0

The only minor problem on other systems could be the
code of reading directories. If you can't fix it, please ask someone with
some experience in programming and using files.
If want to use the new configure script (recommended), you'll need:
-aclocal
-autoheader
-autoconf
-automake
For download see ftp://ftp.gnu.org/  [packages: Automake, Autoconf]


3. Compilation & installation

a) Using the new GNU/autoconf script

	./autogen.sh
	./configure
	make
<optional>
	su
	make install
-or-
	make install-strip
</optional>

autogen.sh runs:
	aclocal && autoheader && autoconf && automake
to save some download time (the tarball is about 25k smaller)
Also, see:
	./configure --help
for some options, like using GL or MesaGL.
Note that since v0.1.8 this script was renamed from autoscript.sh to
autogen.sh to conform with GNU standards.

b) Using the old Makefile.orig

	make -f Makefile.orig
If you have problems with Makefile, check it for libs, directories and
defines. Also, 3dfile links with -lGL -lGLU. So, you people with older Mesa
could change it to -lMesaGL, or, better, create symlinks from
libMesaGL[U].so to libGL[U].so.


4. Using

Use the mouse.
Clicking on executables -> execute them (only when releasing the mouse button).
Clicking on directories -> chdir.
Clicking on other files -> let your favourite $BROWSER handle them.
Use arrows (and th e mouse wheel) to scroll up & down,
left&right, page_up & page_down, home & end.
Right click shows a popup menu, for navigation and file operations, like:
    -view as text / hex / image
Use the bottom menu buttons.
When possible, space bar switches from windowed mode to fullscreen mode,
and vice versa (it works only with some 3d[fx] cards).
You may drag items over WindowMaker dock or KDE apps.
Press ESC, q, Q to exit, and H for a help pane.


5. Where to find it

Look for future versions at the official site:
http://turma.sourceforge.net/software/3dfile/
Send comments to: Mircea Mitu <mirceamitu@users.sourceforge.net>
Please set the subject field to 3dfile or appropriate so I could
take extra attention to the message. If you want to make a link
to 3dfile in your page, I'll be glad to hear about this.
So, please drop me a line if you intend to.


(*) Trademark issue:
SGI asked to not using OpenGL name abusively.
So, this 3dfile use the OpenGL API to ...

(**) Initially, my thoughts were that 3dfile should compile just fine
under Win9x/NT or like. But Siigron warned me that <dirent.h> is a BSD standard,
so a unix one. He's right. To make it work under windoze, the disc-op.[ch]
must be modified with an appropriate Windows version. More likely
3dfile will compile & run under plain DOS (isn't funny?) using djgpp & allegro
(now, glut has a version for djgpp), or under windoze, using Cygnus tools
or like. I'm not very sure about that (I don't have anymore DOS/Win,
so I can't test my assertions) but it should work. If anyone could port
3dfile to other systems (like DOS, win, MacOS or any non-unix OS)
please send me an email.


-----------------------------------------------
Please ignore spelling and punctuation - I did.