diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2019-05-17 09:46:17 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2019-05-17 09:46:17 +0200 |
| commit | 4b0178d44a800784dde018b870f2eb47a2eeec66 (patch) | |
| tree | 348ea4550d26d488e35793787f87b91d68320ebf | |
| parent | f2dfe3ab13148fd1d3bd5adcfaa1b0ee1af89a1a (diff) | |
Update manual with README.md generation by bdep-new
| -rw-r--r-- | doc/manual.cli | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/manual.cli b/doc/manual.cli index 0c91d4c..e044053 100644 --- a/doc/manual.cli +++ b/doc/manual.cli @@ -717,19 +717,19 @@ Name Patterns} for details. Let's take a look at a slightly more realistic root \c{buildfile}: \ -./: {*/ -build/} doc{README LICENSE} manifest +./: {*/ -build/} doc{README.md LICENSE} manifest \ -Here we have the customary \c{README} and \c{LICENSE} files as well as the +Here we have the customary \c{README.md} and \c{LICENSE} files as well as the package \c{manifest}. Listing them as prerequisites achieves two things: they will be installed if/when our project is installed and, as mentioned earlier, they will be included into the project distribution. -The \c{README} and \c{LICENSE} files use the \c{doc{\}} target type. We could -have used the generic \c{file{\}} but using the more precise \c{doc{\}} makes -sure that they are installed into the appropriate documentation directory. The -\c{manifest} file doesn't need an explicit target type since it has a fixed -name (\c{manifest{manifest\}} is valid but redundant). +The \c{README.md} and \c{LICENSE} files use the \c{doc{\}} target type. We +could have used the generic \c{file{\}} but using the more precise \c{doc{\}} +makes sure that they are installed into the appropriate documentation +directory. The \c{manifest} file doesn't need an explicit target type since it +has a fixed name (\c{manifest{manifest\}} is valid but redundant). Standard project infrastructure in place, where should we put our source code? While we could have everything in the root directory of our project, just like @@ -744,7 +744,8 @@ hello/ │ ├── hello.cxx │ └── buildfile ├── buildfile -└── manifest +├── manifest +└── README.md \ \N|There are several reasons for this layout: It implements the canonical @@ -847,7 +848,8 @@ libhello/ ├── tests/ │ └── ... ├── buildfile -└── manifest +├── manifest +└── README.md \ The overall layout (\c{build/}, \c{libhello/} source directory) as well as the |