Table of Contents

Software Manual

• Quick Start
  • First Steps
    • Install BASIS
      • Get a copy of the source code
      • Configure the build
      • Build and install BASIS
      • Set up the environment
    • Create an Example Project
    • Install Your Project
    • Add an Executable
      • Change target properties
      • Test the Executable
    • Add Libraries
      • Add a private library
      • Add a public library
      • Add a scripted module
      • The .in suffix
      • Install the libraries
    • Create a Modularized Repository
      • Create a Top Level Project
      • Create a Sub-project Containing a Library
      • Create a Sub-project that uses the Library
      • Install the Projects
    • Next Steps
• How-to Guides
  • Create/Modify a Project
    • Create a New Project
    • Modify an Existing Project
      • General Notes
      • Adding Features
      • Removing Features
      • Adding Dependencies
      • Removing Dependencies
    • Modularize a Project
      • Create the Top Level Project
      • Create the Modules
      • Configure the build
      • Build the Top Level Project and its Modules
    • Upgrade a Project
      • Resolving Merge Conflicts
  • Using and Customizing Templates
    • Available Templates
    • Use a Template
      • Change the Default Template
    • Create a Custom Template
  • CMake Options
    • Standard CMake
    • BASIS Options
      • Frequently Used
      • Advanced
  • Configure a Project
    • Build Configuration
      • BasisProject.cmake
      • Settings.cmake
      • Depends.cmake
      • Config.cmake.in
      • Version.cmake.in
      • ScriptConfig.cmake.in
      • Package.cmake and Components.cmake
    • Header Files
      • Public Interface
      • Private Interface
      • Search Path
    • Custom Layout
    • Superbuild
      • Bootstrapping BASIS
      • Superbuild of other Dependencies
      • Nested Superbuild of BASIS and other Dependencies
    • Test Configuration
      • CDash
      • Code Coverage
    • Installation
      • Prefix
      • RPATH
    • Redistributable Files
  • Managing Test Data
  • Documenting Software
    • Documentation Quick Start
      • Writing Documentation
      • Generating Documentation
      • Serving Website Locally
    • Doxygen Documentation
      • Language Support
      • Doxygen Filters
      • Generating Doxygen
    • Sphinx Documentation
      • Output Formats
      • Themes
    • Markdown
    • Creating Documentation
    • Software Manual
    • Developer’s Guide
    • API Documentation
    • Software Web Site
  • Branch and Release
    • Branching and Merging
    • Releasing Software
  • Packaging Software
    • Distribution of Sources
  • Install any Software
    • Build Steps Overview
      • Build Steps
    • Prerequisites
      • Required Packages
      • Optional Packages
    • Build and Installation
      • Package Names
      • Binary Distribution Package
      • Building From Sources
    • Deinstallation
      • Makefile-based Uninstall
      • Uninstaller Script
  • Automated Testing
    • The basistest family of scripts
      • basistest-cron
      • basistest-master
      • basistest-slave
      • basistest-svn
    • CDash Integration
    • Administration of Software Testing
      • Initial BASIS Installation
      • Updating the BASIS Installation
      • Configuring Test Jobs
• Standards
  • Filesystem Layout
    • Source Code Repository
      • Git
      • Mercurial
      • Subversion
    • Source Code Tree
    • Build Tree
    • Installation Tree
      • Installation Schemes
      • Possible Schemes
      • Forcing Schemes
  • Project Template
    • Standard Project Files
      • File Formats
      • Required Project Files
      • Common Project Files
      • CMakeLists.txt Build Files
      • Documenation Files
      • Advanced Project Files
    • Template Layout
      • Template Versions
      • Custom Substitutions
  • Project Modularization
    • Filesystem Layout
    • Dependency Requirements
    • Module CMake Variables
    • Implementation
      • Origin
    • Reuse
    • Superbuild
  • Build of Script Targets
    • Prerequisites and Build Steps
    • Script Configuration
  • Command-line Parsing
    • C++
    • Bash
  • Calling Conventions
    • Purpose
    • Relative vs. Absolute Paths
    • File vs. Target Name
    • Search Paths
      • Unix
      • Windows
    • Implementation
      • C++
      • Java
      • Python
      • Perl
      • Bash
    • Unsupported Languages
      • MATLAB
• Guidelines
  • Plain Text Format
• Reference
  • Basic Tools
  • CMake Modules
  • Utilities
  • Project Layout

Download and Installation

• Release Notes
  • Release 3.3.1 (Feb 2, 2017)
  • Release 3.3.0 (Apr 19, 2016)
  • Release 3.2.0 (Oct 16, 2015)
  • Release 3.1.0 (Mar 28, 2014)
  • Release 3.0.0 (Jan 15, 2014)
  • Release 2.1.4 (Apr 20, 2013)
  • Release 2.1.3 (Mar 1, 2013)
  • Release 2.1.2 (Oct 31, 2012)
  • Release 2.1.1 (Oct 25, 2012)
  • Release 2.1.0 (Sep 20, 2012)
  • Release 2.0.1 (Sep 17, 2012)
  • Release 2.0.0 (Aug 28, 2012)
  • Release 1.3.0 (Jun 5, 2012)
  • Release 1.2.3 (Apr 12, 2012)
  • Release 1.2.2 (Apr 4, 2012)
  • Release 1.2.1 (Mar 21, 2012)
  • Release 1.2.0 (Feb 29, 2012)
  • Release 1.0.0 (Feb 18, 2012)
  • Release 1.0.0rc1 (Dec 16, 2011)
  • Pre-Release 0.3.0 (Nov 22, 2011)
  • Pre-Release 0.2.2 (Nov 4, 2011)
  • Pre-Release 0.2.1 (Nov 3, 2011)
  • Pre-Release 0.2.0 (Nov 2, 2011)
  • Pre-Release 0.1.8 (Oct 31, 2011)
  • Pre-Release 0.1.7 (Oct 31, 2011)
  • Pre-Release 0.1.6 (Oct 31, 2011)
  • Pre-Release 0.1.5 (Oct 18, 2011)
  • Pre-Release 0.1.4 (Oct 14, 2011)
  • Pre-Release 0.1.3 (Oct 13, 2011)
  • Pre-Release 0.1.2 (Oct 13, 2011)
  • Pre-Release 0.1.1 (Oct 12, 2011)
  • Pre-Release 0.1.0 (Oct 5, 2011)
• Download
  • Source Code
    • System Requirements
    • Software License
    • Package Content
  • Documentation
• Installation
  • Prerequisites
    • Required Packages
    • Optional Packages
  • Build and Installation
    • Build Steps
    • CMake Options
      • Advanced CMake Options
  • Set up the Environment
  • Deinstallation

Support

• Support
  • Report Issue
  • Frequently Asked Questions
    • Standard CMake Commands
    • CMake Package Configuration
    • Export of Build Targets
• About
  • History
  • Purpose
  • People