From 0f97e997f8758935c535b544ac06414ff4f42a55 Mon Sep 17 00:00:00 2001 From: J-Donald Tournier Date: Wed, 18 Dec 2024 11:58:02 +0000 Subject: [PATCH] Add placeholder for instructions to install build script --- install_build_script.md | 8 ++++++++ week2A.md | 10 ++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 install_build_script.md diff --git a/install_build_script.md b/install_build_script.md new file mode 100644 index 0000000..5e7428e --- /dev/null +++ b/install_build_script.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Install build script - Object-Oriented Programming (5CCYB041) +--- + +# How to install the build script used on the OOP course + +**TODO** diff --git a/week2A.md b/week2A.md index f024151..ddb525c 100644 --- a/week2A.md +++ b/week2A.md @@ -110,7 +110,7 @@ We've barely started on our project, and our `.cpp` file is already ~100 lines -- -In practice, projects are spread over multiple files +In practice, C++ projects are spread over many files - it helps to keep our code logically organised - it keeps each individual file small enough to manage - it allows for incremental and/or parallel compilation @@ -130,7 +130,7 @@ current code -- Files designed to be `#include`d in this way are called *header files* -- they typically have extension `.h` (though `.hpp`, `.H` are also sometimes +- they typically have the `.h` extension (though `.hpp`, `.H` are also sometimes used) -- @@ -749,7 +749,7 @@ This needs to be done *recursively*: --- -# What build system is used in this course? +# What C++ build system is used in this course? To keep things as simple as possible on this course, we will use a simple @@ -758,6 +758,8 @@ script of our own design (the On KCL systems, this script has already been made available as the command `oop_build` +- if you need to install this on your own system, please [follow the + instructions here](https://kcl-bmeis.github.io/OOP/install_build_script) -- @@ -780,7 +782,7 @@ The project must however follow some simple rules -- If you follows the conventions taught on this course, the above rules -will always work for you +should always work for you ---