Changes between Version 3 and Version 4 of StartModDev

Timestamp:

Nov 27, 2012, 6:10:09 PM (10 years ago)

Author:

Beman Dawes

Comment:

Add Header Directories

StartModDev

@@ -6 +6 @@
 
  * An understanding of Boost culture and the Developer's mailing list. [http://www.boost.org/community/ Read more.]
+ * An understanding of [http://www.boost.org/development/requirements.html Boost Library Requirements and Guidelines].
  * The Git version control system. [wiki:StartGit Read about Getting Started with Git.] If you are new to Git, install it and experiment a bit before coming back here.
  * A (free) [http://www.github.com GitHub] account. [wiki:StartGitHub Read about Getting Started with GitHub.] If you are new to !GitHub, be sure to do the [wiki:StartGitHub exercise] before coming back here.
  * Your favorite compiler and development environment.
+ * A recent version of Boost installed.
 
 == Overview ==
@@ -15 +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.
  * 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 may have private branches that are never pushed to the public repo.
- * Portions of your library's directory structure must conform to Boost conventions, so both users and automatic processes can find header files, test files, build configurations, and the like. Otherwise your library's directory structure is up to you. 
+ * 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. 
  
+== Header Directories ==
 
+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 foo would look like:
+
+
+{{{
+     foo
+       include
+         boost
+           foo
+             foo.hpp
+       test
+         foo_test.cpp
+         Jamfile.v2
+       index.html   
+}}}
+