libx3d documentation -- Notes on how the directories, files, etc.
libx3d project version 0.1
Author: Alexis Wilke
IMPORTANT NOTE: if you are reading the dev package, then many files
will be found under dev/* instead; also, the dev
package includes all the files that you need to
create the entire world!
This package includes:
base/* the X3D dataset library (nodes) (include, src)
BUILD/* suggested sub-directory to compile the code:
doc/CHANGES.txt the changes in the different releases
configure the configure script; run it to generate the
Makefile's; to get the different options type:
dev/* only in the dev package; includes all the
basic development scripts, the original files
of the documentation, etc.
doc/* all the documentation, including our special
version of the X3D specification used to generate
the X3D dataset defined in the base/* directory;
this is NOT included in the dev package since it
is generated from its content (see dev/create_docs)
io/* the X3D reading/writing: XML, VRML, etc.
LICENSE there are several licenses; the libraries
are licensed under the LGPL; the tools under
the GPL; most scripts and utilities are under
the MIT license (very similar to the BSD).
check the LICENSE in a specific directory to
know how most of the files in that directory
are covered; edit files to see the license at
the top of the file
Makefile.am the original auto-make makefiles
render/* the X3D rendering engine (OpenGL) (include, src)
tmp/* automatically created by different scripts when
you create the whole world.
tools/* X3D tools; mainly to test the library, but some
of these can actually be useful
utilities/* files used to generate the libraries; for instance
there is html-to-header.c++ which parses the HTML
and DTD files for nodes and generate the
corresponding C++ code; there is also a smart pointer
implementation so we don't have to manage the reference