Skip to content

Commit

Permalink
Add placeholder for instructions to install build script
Browse files Browse the repository at this point in the history
  • Loading branch information
jdtournier committed Dec 18, 2024
1 parent b7aa730 commit 0f97e99
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
8 changes: 8 additions & 0 deletions install_build_script.md
Original file line number Diff line number Diff line change
@@ -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**
10 changes: 6 additions & 4 deletions week2A.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

--
Expand Down Expand Up @@ -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
Expand All @@ -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)

--

Expand All @@ -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

---

Expand Down

0 comments on commit 0f97e99

Please sign in to comment.