Editing Building from SVN
From BRL-CAD
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | + | == Obtain the sources via Subversion == | |
+ | |||
+ | For Linux/Mac/BSD: | ||
+ | <pre>svn checkout https://svn.code.sf.net/p/brlcad/code/brlcad/trunk brlcad</pre> | ||
− | + | Note: If you do not yet have an SVN client installed, go to http://subversion.tigris.org for information on obtaining an appropriate SVN client for your platform. Most modern Linux/BSD/UNIX distributions will also have SVN available in their package repositories. | |
For Windows: | For Windows: | ||
Line 8: | Line 11: | ||
To get a checkout after installing TortoiseSVN, right-click in a folder where you want to download the sources, select SVN Checkout and specify https://svn.code.sf.net/p/brlcad/code/brlcad/trunk for the repository URL. | To get a checkout after installing TortoiseSVN, right-click in a folder where you want to download the sources, select SVN Checkout and specify https://svn.code.sf.net/p/brlcad/code/brlcad/trunk for the repository URL. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
== Configure the build system with CMake == | == Configure the build system with CMake == | ||
Line 19: | Line 17: | ||
Once installed, create a directory where you will compile BRL-CAD and run CMake. | Once installed, create a directory where you will compile BRL-CAD and run CMake. | ||
− | |||
− | |||
For Linux/Mac/BSD, this looks like: | For Linux/Mac/BSD, this looks like: | ||
Line 29: | Line 25: | ||
cmake .. (for a default build) | cmake .. (for a default build) | ||
cmake .. -DBRLCAD_BUNDLED_LIBS=ON -DCMAKE_BUILD_TYPE=Release (for a release build) | cmake .. -DBRLCAD_BUNDLED_LIBS=ON -DCMAKE_BUILD_TYPE=Release (for a release build) | ||
+ | |||
+ | For Windows, you can use the CMake GUI where you specify build and source directories:[[File:Running_cmake_on_windows.png|200px|thumb|right|Running CMake GUI on Windows]] | ||
== Compile and test your build == | == Compile and test your build == | ||
− | |||
− | |||
On Linux/Mac/BSD, run this in your build directory: | On Linux/Mac/BSD, run this in your build directory: | ||
Line 38: | Line 34: | ||
make | make | ||
− | + | At this point, you should have a fully installed and working system. You can test things by doing: | |
make test | make test | ||
− | |||
− | |||
− | |||
make benchmark | make benchmark | ||
Both the test and benchmark should report successfully if everything is working correctly. Report any failures to the BRL-CAD [http://sourceforge.net/tracker/?group_id=105292&atid=640802 bug tracker]. | Both the test and benchmark should report successfully if everything is working correctly. Report any failures to the BRL-CAD [http://sourceforge.net/tracker/?group_id=105292&atid=640802 bug tracker]. | ||
+ | On Windows, open the BRLCAD solution and Compile. | ||
== Doxygen (OPTIONAL) == | == Doxygen (OPTIONAL) == | ||
If you have doxygen installed somewhere CMake can find it, then you can build a browsable HTML documentation of the source code. This is useful if you want to use BRL-CAD's libraries directly, or if you just want a better overview of how things are structured. | If you have doxygen installed somewhere CMake can find it, then you can build a browsable HTML documentation of the source code. This is useful if you want to use BRL-CAD's libraries directly, or if you just want a better overview of how things are structured. | ||
− | To build the HTML files on a | + | To build the HTML files on a UNIX system, run (from your build directory) |
make dox | make dox | ||
Line 66: | Line 60: | ||
== Setup environment (OPTIONAL) == | == Setup environment (OPTIONAL) == | ||
− | At this point, | + | At this point, everything should be ready for use. If the default prefix of /usr/brlcad was used or if the corresponding symbolic links were created, users should only need to add /usr/brlcad/bin to their PATH in order to find binaries for the package (optionally setting their MANPATH as well): |
− | |||
− | |||
− | |||
− | |||
For bash: | For bash: | ||
− | export PATH= | + | export PATH=/usr/brlcad/bin:$PATH |
− | export MANPATH= | + | export MANPATH=/usr/brlcad/man:$MANPATH |
For csh/tcsh: | For csh/tcsh: | ||
set path=( /usr/brlcad/bin $path ) | set path=( /usr/brlcad/bin $path ) | ||
− | setenv MANPATH | + | setenv MANPATH /usr/brlcd/man:$MANPATH |
rehash | rehash | ||
− | To find BRL-CAD manual pages without setting your MANPATH, use the provided "brlman" binary instead of "man" | + | If users do not want to modify their PATH, they can get by providing the full path to the binaries (e.g. /usr/brlcad/bin/mged). To find BRL-CAD manual pages without setting your MANPATH, use the provided "brlman" binary instead of "man". |
+ | == Test your Build == | ||
− | + | If compilation went well, there should now be more than 400 command-line applications at your disposal for processing images and geometry. A quick test of functionality (and performance) is to run the BRL-CAD benchmark if you're not on Windows: | |
+ | |||
+ | benchmark | ||
− | + | Regardless, you should be able to run the main modeling application: | |
mged | mged |