Changes between Version 4 and Version 5 of StartModDev
- Timestamp:
- Nov 29, 2012, 12:46:58 AM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
StartModDev
v4 v5 1 1 = Getting Started with Modularized Boost Library Development = 2 2 3 || This is a work in pro cess ||3 || This is a work in progress || 4 4 5 5 == Prerequisites == … … 14 14 == Overview == 15 15 16 * The Boost repository itself treats your library as a sub-module, i.e. a link to a particular release in your library's public GitHub repository.17 * Your library has a "master" branch for development work, and a "release" branch for your releases, which occur asynchronously from Boost releases. You may also have other branches, but that's up to you.18 * You (and the rest of your team) do day-to-day development using private repositories on your local machines. You push changes from these local private repos up to the public repo whenever you want. The local repos mayhave private branches that are never pushed to the public repo.16 * Your library has its own public repository that has a "develop" branch for development work, and a "master" branch for your releases, which occur asynchronously from Boost releases. You may also have other branches, but that's up to you. 17 * The Boost super project has its own public repository. It treats your library as a sub-module, i.e. a link to a particular release in your library's public GitHub repository. 18 * You (and the rest of your team) do day-to-day development using private repositories on your local machines. You push changes from these local private repos up to your library's public repo whenever you want. The local repos may also have private branches that are never pushed to the public repo. 19 19 * Your library's directory structure conforms to [http://www.boost.org/development/requirements.html#Directory_structure Boost directory structure conventions], so both users and automatic processes can find header files, test files, build configurations, and the like. Beyond the conventions, your library's directory structure is up to you. 20 20 21 == Header Directories==21 == Directory Structure == 22 22 23 For Modularized Boost, header files are placed in a {{{include/boost}}} header hierarchy within your main directory. Here is what a very simple library named foowould look like:23 For Modularized Boost, header files are placed in a {{{include/boost}}} header hierarchy within your main directory. Here is what a very simple header-only library named {{{simple}}} would look like: 24 24 25 25 26 26 {{{ 27 foo27 simple 28 28 include 29 29 boost 30 foo31 foo.hpp30 simple 31 twice.hpp 32 32 test 33 foo_test.cpp33 twice_test.cpp 34 34 Jamfile.v2 35 35 index.html 36 36 }}} 37 37 38 == Creating the {{{simple}}} library == 39