Skip to content

Commit 635ba86

Browse files
committed
Merge branch 'master' into AdaptFolderLayout
2 parents 8f6fd8f + cdab539 commit 635ba86

File tree

7 files changed

+456
-0
lines changed

7 files changed

+456
-0
lines changed

TODO.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Some topics listed on GitHub are unclear as to their meaning.
2+
e.g. Heterogeneous Compiling
3+
[Is "Heterogeneous Computing" intended or "Cross Compiling"?]
4+
There are others too.
5+
6+
More thought is needed on naming conventions for labels for
7+
knowledge areas/units.

sources/course_examples.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Examples of Course Curricula
2+
3+
[**NOTE**: Anyone have any suggestions of items to add here?]
4+
The following are examples of curricula for course on C++:
5+
...

sources/disclaimer.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Disclaimer
2+
3+
This document is intended as a proof of concept to solicit feedback
4+
from others.
5+
This document is incomplete.
6+
This document likely has at least a few errors.

sources/main.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title_logo: images/cpp_logo.png
3+
title: Guidelines for Teaching C++
4+
author: SG20 (ISO C++ Study Group on Education)
5+
geometry: margin=1in
6+
output: pdf_document
7+
---
8+
9+
__INCLUDE__(obtaining_document.md)
10+
11+
__INCLUDE__(disclaimer.md)
12+
13+
__INCLUDE__(introduction.md)
14+
15+
# Summary of Modules and Topics
16+
17+
In the sections that follow, the various modules and topics
18+
are presented.
19+
There is one section per module.
20+
For each module, a table listing the various topics in that module
21+
is provided.
22+
The ID for a topic is linked to the detailed coverage of that
23+
topic that comes later in the document.
24+
If a topic has any learning outcomes at a given proficiency level, this is
25+
indicated by a checkmark ("✔️").
26+
If a topic has no learning outcomes
27+
(simply because there
28+
are not any, not because the information is missing),
29+
this is indicated by an em dash ("—").
30+
In the case that the information for a topic is completely
31+
missing, a question mark ("?") symbol is used.
32+
33+
[**NOTE**: These topics are taken mostly from the SG20 GitHub repository.
34+
They are not intended to be complete in any sense.
35+
In fact, by gathering together all topics in one place where they are
36+
easily viewed, it is hoped that missing and unbalanced items will be more
37+
obvious.]
38+
39+
__INCLUDE__(knowledge_areas_summary.md)
40+
41+
# Detailed Information for Modules and Topics
42+
43+
[//]: # ( ********** START OF DETAILED TOPIC DOCUMENTS ********** )
44+
45+
__INCLUDE__(modules/object-model/copy-semantics.md)
46+
47+
__INCLUDE__(modules/functions/user-defined-literals.md)
48+
49+
__INCLUDE__(modules/functions/defaulted-parameters.md)
50+
51+
__INCLUDE__(modules/compile-time-programming/requires-expressions.md)
52+
53+
__INCLUDE__(modules/meta-error-handling/static_assert.md)
54+
55+
[//]: # ( ********** END OF DETAILED TOPIC DOCUMENTS ********** )
56+
57+
__INCLUDE__(course_examples.md)
58+
59+
# License {#license}
60+
61+
**[NOTE: This license is copied verbatim from the C++ Core Guidelines.]**
62+
```
63+
__INCLUDE__(../LICENSE.txt)
64+
```
65+
66+
# Contributors
67+
68+
```
69+
__INCLUDE__(contributors.md)
70+
```
71+
72+
__INCLUDE__(contributing.md)
73+
74+
__INCLUDE__(glossary.md)
75+
76+
__INCLUDE__(references.md)

0 commit comments

Comments
 (0)