Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 3.45 KB

README.md

File metadata and controls

58 lines (45 loc) · 3.45 KB

vscode-cmake-hello

Simple project to build a program and library in VSCode using CMake. Testing using GoogleTest is included.

CMake is the defacto standard for build systems. It is supported by every IDE that supports C++. This repository contains the code that was developed in a set of five articles that I wrote about using "Modern" CMake and Visual Studio Code to create a simple C++ library and application. The project is further enhanced to create unit tests using Google Test. CMake files are created to download and build Google Test and to integrate it into the project.

Looking at the code for this repository, you will see that there are three subdirectories in the root directory. They contain the following:

part1

part1 contains the C++ and CMake code that corresponds to the code developed in Building C++ Applications With CMake and Visual Studio Code. In that article, a simple C++ static library and program are created. The CMake directives in the CMakeLists.txt files required to build the library and program are described.

shared_libs

shared_libs contains all of the code from part1 and the changes required to change the library from static to shared. The changes are described in Building C++ Applications With Visual Studio Code – Creating a Shared Library. An alternative method that works only on Windows using the Visual Studio build tools is also described in that article.

testing

testing contains all of the code from shared_libs plus the changes required to download and build Google Test and to create unit tests for the library. The code in this folder is used in the remaining three articles: Building C++ Applications With Visual Studio Code – Unit Testing With GoogleTest, Building C++ Applications With Visual Studio Code – Saving the Project to Source Control Using git, and Building C++ Applications With Visual Studio Code – Porting to Linux.

In addition to these folders, a .gitignore file, which is created in the article on source control, is located in the root directory for this repository.

How to Use This Repository

Clone the repository to your Projects file. If you have not already done so, set up your IDE. If you intend to use Visual Studio Code and have not installed it yet, then follow the instructions in the first article. On Windows, open Developer Command Prompt. On any Unix-like system, open a terminal. Change directories to your Projects directory, then:

cd vscode-cmake-hello
cd part1
code .

This opens VS Code in the part1 folder. You can build the project from within the IDE using CMake. Again, instructions are included in the first article.

Similarly, you can change to either of the other two folders and build the project using CMake. See the user manual for your IDE for instructions.