Browse Source

CHANGE: Add readme, license info and a very basic install howto.

git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@137 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
kimmi 17 years ago
parent
commit
e085cc6c3e
3 changed files with 93 additions and 3 deletions
  1. 20 3
      CREDITS
  2. 7 0
      INSTALL
  3. 66 0
      README

+ 20 - 3
CREDITS

@@ -6,13 +6,30 @@ Developers and Contributors
 The following is the list of all constributors.
 The following is the list of all constributors.
 Thanks for your help!
 Thanks for your help!
 
 
+- Andreas Geissler,
+3DS-, ACE-, DXF-, HMP-, HDO-, MD2-, MD3-, MD5-, MDC-, MDL-, NFF-, PLY-, RAW-, SDM-, LWO2- and SDL-Loader, 
+Configuration-Interface, AssImp-Viewer (Win32), Website (Admin and Design), admin.
+
+-Thomas Schulze,
+X-Loader, Preprocessing framework.
+
+-R.Schmidt,
+Linux build, eclipse support.
+
+- Kim Kulling:
+Obj-Loader, Logging, Scons-build enviroment.
+
+- Matthias Gubisch,
+Visual Studio 9 support, bugfixes.
+
 - Andrew Galante,
 - Andrew Galante,
 submitted patches to make Assimp compile with GCC-4, a makefile and the xcode3 workspace.
 submitted patches to make Assimp compile with GCC-4, a makefile and the xcode3 workspace.
 
 
 - Andreas Nagel
 - Andreas Nagel
-tested Assimp under Windows Vista 64 Bit
+tested Assimp under Windows Vista 64 Bit.
 
 
 - Marius Schröder
 - Marius Schröder
-allowed us to use many of his models for screenshots and testing
+allowed us to use many of his models for screenshots and testing.
 
 
-... and many others
+- Sebastian Hempel,
+Compile-Bugfixes for mingw, add enviroment for static library support in make.

+ 7 - 0
INSTALL

@@ -0,0 +1,7 @@
+	Open Asset Import Library (Assimp) Install
+	-----------------------------------------
+To take a look into the ASSIMP library just get the code, go to the 
+workspaces-directory and open your prefered build enviroment. Now just build 
+the engine, start the ASSIMP-Viewer application and select one of our basic test-files.
+
+You need boost-1.35 to build the Asset Import Library.

+ 66 - 0
README

@@ -0,0 +1,66 @@
+	Open Asset Import Library (Assimp) Readme
+	-----------------------------------------
+
+Here you can find information regarding the Asset Import Library:
+
+	1.		Overview
+	1.1		Supported file formats
+	1.2		File structure
+	2.		Build the Asset Import Library
+	3. 		Help
+	4.		License
+
+
+1.	Overview
+1.1	Supported file formats
+
+The Asset Import Library provides a lot of model formats:
+	- 3DS
+	- ACE
+	- DXF
+	- HMP
+ 	- HDO
+	- MD2
+ 	- MD3 
+	- MD5
+	- MDC
+	- MDL
+	- NFF
+ 	- PLY
+ 	- RAW
+	- SDM
+	- SDL
+	- LWO2
+
+1.2 File structure
+
+The Asset Import Library is implemented in C++ and provides a c-interface. The directories 
+are:
+
+	/bin			Binaries of the Asset Import Library.
+	/code			Code of the Asset Import Library.
+	/contrib		Third-party-libraries used by the Asset Import Library.
+	/doc			Documentation (doxygen generated and data structure as a xml-file)
+	/include		Public headers.
+	/lib			Static libraries.
+	/obj			Object files.
+	/port			Ports to other languages. Java is currently implemented.
+	/test			Unit- and regression tests.
+	/tools			Tools.
+	/workspaces		Build enviroments.
+
+
+2. Build the Asset Import Library
+
+Take a look into the INSTALL file.
+
+
+3. Help
+
+For more help go to http://assimp.sourceforge.net/ or go to http://www.zfx.info. Or take a look 
+into the /doc-directory.
+
+
+4. License
+
+The license of the Asset Import Library is based on the BSD-License.