Skip to content

Commit fecda3b

Browse files
authored
Merge pull request #451 from bast/chapter-15-readme
provide context for chapter 15; closes #394
2 parents 79a6cdf + 8b91440 commit fecda3b

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,4 +166,4 @@
166166
- [Using the ThreadSanitizer and reporting data races to CDash](chapter-14/recipe-04/README.md)
167167

168168

169-
### [Chapter 15: Porting a Project to CMake](https://github.com/dev-cafe/vim/compare/master...cmake-support)
169+
### [Chapter 15: Porting a Project to CMake](chapter-15/README.md)

chapter-15/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# Chapter 15: Porting a Project to CMake
4+
5+
The final chapter of the cookbook demonstrates step-by-step how to port a
6+
non-trivial project to CMake.
7+
8+
The example project is the source code behind the popular editor Vim
9+
(https://www.vim.org) in which we port the configuration and compilation from
10+
Autotools to CMake.
11+
12+
Here we link to the diff between "before" and "after":
13+
https://github.com/dev-cafe/vim/compare/b476cb7...cmake-support
14+
15+
However, this diff probably only makes sense in combination with the textbook
16+
in contrast to all other recipes which can be reused also independently.

contributing/generate-readmes.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ def generate_main_readme(directory_of_this_script, chapters, chapter_titles,
8888
# chapter 15 is hard-coded
8989
# since it points to an outside diff
9090
f.write(
91-
'\n\n### [Chapter 15: Porting a Project to CMake](https://github.com/dev-cafe/vim/compare/master...cmake-support)\n'
91+
'\n\n### [Chapter 15: Porting a Project to CMake](chapter-15/README.md)\n'
9292
)
9393

9494

@@ -99,6 +99,10 @@ def locate_chapters_and_recipes(directory_of_this_script):
9999
paths = (directory_of_this_script.parent).glob('chapter-*')
100100
chapters = sorted((path.parts[-1] for path in paths))
101101

102+
# chapter 15 is different and "hardcoded"
103+
# so we remove it from the list of chapters to process
104+
chapters.remove('chapter-15')
105+
102106
recipes = {}
103107
for chapter in chapters:
104108
paths = (directory_of_this_script.parent / chapter).glob('recipe-*')

0 commit comments

Comments
 (0)