- fix Readme formatting.

git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@1140 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
pull/5/head
aramis_acg 2012-02-02 16:30:10 +00:00
parent 29b4d01e2d
commit 4448ea73c2
1 changed files with 22 additions and 17 deletions

View File

@ -13,8 +13,10 @@ Open Asset Import Library (_assimp_)
1. Overview
------------------------------
1. Overview
=============
Open Asset Import Library is a Open Source library designed to load various 3d file formats and convert them into a shared, in-memory format. It supports more than 30 file formats. It also supports exporting files to a few selected file formats.
@ -22,9 +24,9 @@ Its short name is _assimp_, which is an unintended joke (the abbreviation is der
__Note__: this `README` refers to the file structure used by release packages, which differs in some points from the development trunk.
----------------
1.1 Supported file formats
----------------
1.1 Supported file formats
-------------
The library provides importers for a lot of file formats, including:
@ -63,9 +65,9 @@ Exporters include:
See [the full list here](http://assimp.sourceforge.net/main_features_formats.html).
----------------
1.2 Repository structure
----------------
-------------
Open Asset Import Library is implemented in C++ (but provides both a C and a
C++ish interface). The directory structure is:
@ -88,29 +90,32 @@ C++ish interface). The directory structure is:
2. Build the library
------------------------------
=============
Take a look into the `INSTALL` file. Or fire up CMake with the usual steps.
------------------------------
3. Where to get help
------------------------------
=============
For more information, visit [our website](http://assimp.sourceforge.net/). Or check out the `./doc`- folder, which contains the official documentation in HTML format.
(CHMs for Windows are included in some release packages and should be located right here in the root folder).
If the documentation doesn't solve your problems, try our forums at SF.net
> [Open Discussion](http://sourceforge.net/projects/assimp/forums/forum/817653)
> [General Help](http://sourceforge.net/projects/assimp/forums/forum/817654)
For development stuff, there is also a mailing list, _assimp-discussions_
[subscribe here]( https://lists.sourceforge.net/lists/listinfo/assimp-discussions)
------------------------------
- [Open Discussion](http://sourceforge.net/projects/assimp/forums/forum/817653)
- [General Help](http://sourceforge.net/projects/assimp/forums/forum/817654)
For development stuff, there is also a mailing list, _assimp-discussions_
[(subscribe here)]( https://lists.sourceforge.net/lists/listinfo/assimp-discussions)
4. License
------------------------------
=============
The license of the Asset Import Library is based on the modified, __3-clause BSD__-License, which is a very liberal license. An _informal_ summary is: do whatever you want, but include Assimp's license text with your product - and don't sue us if our code doesn't work.