Skip to content

Commit

Permalink
Merge pull request #7 from ttroy50/link_updates
Browse files Browse the repository at this point in the history
Link updates
  • Loading branch information
ttroy50 committed Feb 14, 2016
2 parents b872b7c + 1208416 commit c1ac072
Show file tree
Hide file tree
Showing 16 changed files with 66 additions and 65 deletions.
6 changes: 3 additions & 3 deletions 01-basic/A-hello-cmake/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ A-hello-cmake$ tree
├── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - A simple "Hello World" cpp file.
* link:CMakeLists.txt[CMakeLists.txt] - Contains the CMake commands you wish to run
* link:main.cpp[main.cpp] - A simple "Hello World" cpp file.

# Concepts

Expand Down Expand Up @@ -233,7 +233,7 @@ All examples in this tutorial will use out-of-source builds.

# Building the Examples

Below is sample output from building this example.
Below is sample output from building this example.

[source,bash]
----
Expand Down
8 changes: 4 additions & 4 deletions 01-basic/B-hello-headers/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ B-hello-headers$ tree
└── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run.
* inc/Hello.h - The header file to include.
* src/Hello.cpp - A source file to compile.
* src/main.cpp - The source file with main.
* link:CMakeLists.txt[CMakeLists.txt] - Contains the CMake commands you wish to run.
* link:inc/Hello.h[inc/Hello.h] - The header file to include.
* link:src/Hello.cpp[src/Hello.cpp] - A source file to compile.
* link:src/main.cpp[src/main.cpp] - The source file with main.


# Concepts
Expand Down
8 changes: 4 additions & 4 deletions 01-basic/C-static-library/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ $ tree
└── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* inc/Hello.h - The header file to include
* src/Hello.cpp - A source file to compile
* src/main.cpp - The source file with main
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:inc/Hello.h[] - The header file to include
* link:src/Hello.cpp[] - A source file to compile
* link:src/main.cpp[] - The source file with main


# Concepts
Expand Down
8 changes: 4 additions & 4 deletions 01-basic/D-shared-library/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ $ tree
└── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* inc/Hello.h - The header file to include
* src/Hello.cpp - A source file to compile
* src/main.cpp - The source file with main
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:inc/Hello.h[] - The header file to include
* link:src/Hello.cpp[] - A source file to compile
* link:src/main.cpp[] - The source file with main


# Concepts
Expand Down
10 changes: 5 additions & 5 deletions 01-basic/E-installing/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ $ tree
└── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* cmake-examples.conf - An example configuration file
* inc/Hello.h - The header file to include
* src/Hello.cpp - A source file to compile
* src/main.cpp - The source file with main
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:cmake-examples.conf[] - An example configuration file
* link:inc/Hello.h[] - The header file to include
* link:src/Hello.cpp[] - A source file to compile
* link:src/main.cpp[] - The source file with main

# Concepts

Expand Down
4 changes: 2 additions & 2 deletions 01-basic/F-build-type/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ $ tree
├── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - The source file with main
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:main.cpp[] - The source file with main

# Concepts

Expand Down
4 changes: 2 additions & 2 deletions 01-basic/G-compile-flags/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ $ tree
├── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - The source file with main
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:main.cpp[] - The source file with main

# Concepts

Expand Down
4 changes: 2 additions & 2 deletions 01-basic/H-third-party-library/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ $ tree
├── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - The source file with main
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:main.cpp[] - The source file with main

# Requirements

Expand Down
6 changes: 3 additions & 3 deletions 01-basic/I-compiling-with-clang/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ method of changing the compiler from the default gcc to http://clang.llvm.org/[c
The files in this tutorial are below:

```
A-hello-cmake$ tree
$ tree
.
├── CMakeLists.txt
├── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - A simple "Hello World" cpp file.
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:main.cpp[] - A simple "Hello World" cpp file.

# Concepts

Expand Down
8 changes: 4 additions & 4 deletions 01-basic/J-building-with-ninja/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ toc::[]

# Introduction

As mentioned in the introduction, CMake is a meta-build system that can be used to
As mentioned, CMake is a meta-build system that can be used to
create the build files for many other build tools. This example shows how
to have CMake use the https://ninja-build.org/[ninja build] tool.

The files in this tutorial are below:

```
A-hello-cmake$ tree
$ tree
.
├── CMakeLists.txt
├── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - A simple "Hello World" cpp file.
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:main.cpp[] - A simple "Hello World" cpp file.

# Concepts

Expand Down
17 changes: 9 additions & 8 deletions 02-sub-projects/A-basic/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ create the following:
The files included in this example are:

```
$ tree
.
├── CMakeLists.txt
├── subbinary
Expand All @@ -34,14 +35,14 @@ The files included in this example are:
└── sublib2.h
```

* CMakeLists.txt - Top level CMakeLists.txt
* subbinary/CMakeLists.txt - to make the executable
* subbinary/main.cpp - source for the executable
* sublibrary1/CMakeLists.txt - to make a static library
* sublibrary1/inc/sublib1.h
* sublibrary1/src/sublib2.cpp
* sublibrary2/CMakeLists.txt - to setup header only library
* sublibrary2/inc/sublib2.h
* link:CMakeLists.txt[] - Top level CMakeLists.txt
* link:subbinary/CMakeLists.txt[] - to make the executable
* link:subbinary/main.cpp[] - source for the executable
* link:sublibrary1/CMakeLists.txt[] - to make a static library
* link:sublibrary1/inc/sublib1.h[]
* link:sublibrary1/src/sublib2.cpp[]
* link:sublibrary2/CMakeLists.txt[] - to setup header only library
* link:sublibrary2/inc/sublib2.h[]

# Concepts

Expand Down
8 changes: 4 additions & 4 deletions 03-code-generation/configure-files/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ $ tree
├── ver.h.in
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - The source file with main
* path.h.in - File to contain a path to the build directory
* ver.h.in - File to contain the version of the project
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:main.cpp[] - The source file with main
* link:path.h.in[] - File to contain a path to the build directory
* link:ver.h.in[] - File to contain the version of the project

# Concepts

Expand Down
6 changes: 3 additions & 3 deletions 03-code-generation/protobuf/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ $ tree
├── main.cpp
```

* AddressBook.proto - proto file from main protocol buffer https://developers.google.com/protocol-buffers/docs/cpptutorial[example]
* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - The source file from the protobuf example.
* link:AddressBook.proto[] - proto file from main protocol buffer https://developers.google.com/protocol-buffers/docs/cpptutorial[example]
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:main.cpp[] - The source file from the protobuf example.

# Requirements

Expand Down
16 changes: 8 additions & 8 deletions 04-static-analysis/cppcheck/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ analysis on all sub-projects.
The files included in this example are:

```
cppcheck$ tree
$ tree
.
├── cmake
│   ├── analysis.cmake
Expand All @@ -34,13 +34,13 @@ cppcheck$ tree
└── main2.cpp
```

* CMakeLists.txt - Top level CMakeLists.txt
* cmake/analysis.cmake - Includes functions to add analysis targets
* cmake/modules/FindCppCheck.cmake - A custom package module to find CppCheck
* subproject1/CMakeLists.txt - CMake commands for subproject 1
* subproject1/main.cpp - source for a subproject with no errors
* subproject2/CMakeLists.txt - CMake commands for subproject 2
* subproject2/main2.cpp - source for a subproject that includes errors
* link:CMakeLists.txt[] - Top level CMakeLists.txt
* link:cmake/analysis.cmake[] - Includes functions to add analysis targets
* link:cmake/modules/FindCppCheck.cmake[] - A custom package module to find CppCheck
* link:subproject1/CMakeLists.txt[] - CMake commands for subproject 1
* link:subproject1/main.cpp[] - source for a subproject with no errors
* link:subproject2/CMakeLists.txt[] - CMake commands for subproject 2
* link:subproject2/main2.cpp[] - source for a subproject that includes errors

# Requirements

Expand Down
8 changes: 4 additions & 4 deletions 05-unit-testing/boost/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ $ tree
├── unit_tests.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* Reverse.h / .cpp - Class to reverse a string
* Palindrome.h / .cpp - Class to test if a string is a palindrome
* unit_test.cpp - Unit Tests using boost unit test framework
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:Reverse.h[] / link:Reverse.cpp[.cpp] - Class to reverse a string
* link:Palindrome.h[] / link:Palindrome.cpp[.cpp] - Class to test if a string is a palindrome
* link:unit_test.cpp[] - Unit Tests using boost unit test framework

# Requirements

Expand Down
10 changes: 5 additions & 5 deletions 06-installer/deb/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ $ tree
└── main.cpp
```

* CMakeLists.txt - Contains the CMake commands you wish to run
* cmake-examples.conf - An example configuration file
* inc/Hello.h - The header file to include
* src/Hello.cpp - A source file to compile
* src/main.cpp - The source file with main
* link:CMakeLists.txt[] - Contains the CMake commands you wish to run
* link:cmake-examples.conf[] - An example configuration file
* link:inc/Hello.h[] - The header file to include
* link:src/Hello.cpp[] - A source file to compile
* link:src/main.cpp[] - The source file with main

# Concepts

Expand Down

0 comments on commit c1ac072

Please sign in to comment.