Improve INSTALL.

git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@531 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
pull/1/head
aramis_acg 2010-01-24 00:47:25 +00:00
parent c999f65a7d
commit ce29aca94e
1 changed files with 20 additions and 22 deletions

28
INSTALL
View File

@ -5,15 +5,17 @@ Open Asset Import Library (Assimp) Install
=======================================================================
Please see the doxygen documentation for full install instructions:
Please refer to the doxygen documentation for full install instructions
=======================================================================
A regularly-updated copy is available at
http://assimp.sourceforge.net/lib_html/index.html
A CHM file is included in the SVN repos: ./doc/AssimpDoc_Html/AssimpDoc.chm.
At least Windows should be able to read it.
To build the doxygen doc on your own follow these steps:
To build the doxygen documentation on your own, follow these steps:
a) download & install latest doxygen
b) ensure doxygen is in the executable search path
b) make sure doxygen is in the executable search path
c) navigate to ./doc
d) and run 'doxygen'
@ -21,21 +23,17 @@ Open the generated HTML (AssimpDoc_Html/index.html) in the browser of your choic
Windows only: To generate the CHM doc install the 'Microsoft HTML Workshop'
and configure the path to it in the DOXYFILE. Run doxygen again.
You can also find a copy of the doc on our web site:
http://assimp.sourceforge.net/lib_html/index.html
Beware, it could be outdated. If you're in serious doubt it might be,
rebuilding the doc is probably a wise choice.
=======================================================================
For the inpatient:
Windows: go to ./workspaces/vc8 or ./workspaces/vc9, open the
VS Solution and build your preferred build target ...
VS Solution and build for your preferred build target ...
release-dll is usually the best choice. Adjust the runtime library to
your needs, multithreaded-dll is preconfigured by default.
Linux: try make in the ./code dir. Alternatively, run scons from
./workspaces/SCons.
Unix: try running 'make' in the ./code dir. Or SCons from
./workspaces/SCons. Or CMAKE, from the CMakelists.txt. Choose whatever
buildtool you like most.