Skip to content

Commit 5c9a884

Browse files
author
Drizzy
committed
Documentation update
1 parent 4a282e4 commit 5c9a884

2 files changed

Lines changed: 44 additions & 14 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Create C++ projects, compile, and run programs directly from the VSCode interfac
1010

1111
## Requirements
1212

13-
- You must have `make` installed on your computer. [See instructions](docs/SETUP.md#make)
14-
- For Linux, install `gcc`. [See instructions](docs/SETUP.md#linux)
15-
- For Windows, install `mingw`. [See instructions](docs/SETUP.md#windows)
16-
- For macOS, install `clang`. [See instructions](docs/SETUP.md#mac)
13+
- You must have `make` installed on your computer. [See instructions](docs/SETUP.md#install-make)
14+
- For Windows, install `mingw`. [See instructions](docs/SETUP.md#windows-1)
15+
- For Linux, install `gcc`. [See instructions](docs/SETUP.md#gnulinux-1)
16+
- For macOS, install `clang or gcc`. [See instructions](docs/SETUP.md#macos-1)
1717

1818
## How to use
1919

docs/SETUP.md

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,15 @@ sudo pacman -Syu
4040
sudo pacman -S make
4141
```
4242
43-
## Mac
43+
## macOS
4444
45-
If you're on macOS and have [Homebrew](https://docs.brew.sh/Installation) installed, you can easily install make with the following command:
45+
You can install `make` through [Homebrew](https://docs.brew.sh/Installation), a popular package management system for macOS. If you don't have Homebrew installed yet, you can do so with the following command:
46+
47+
```bash
48+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
49+
```
50+
51+
After installing Homebrew, use the following command to install make:
4652

4753
```bash
4854
brew install make
@@ -52,7 +58,7 @@ brew install make
5258

5359
## Windows
5460

55-
To install gcc on Windows, follow these steps:
61+
To install `gcc` on Windows, follow these steps:
5662

5763
Download [ Mingw-w64](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download " Mingw-w64") and launch the installer.
5864

@@ -84,30 +90,54 @@ If it's not installed, follow the instructions for your distribution:
8490
```bash
8591
sudo apt update
8692
sudo apt install build-essential
87-
8893
```
8994
9095
### Arch Linux
9196
9297
```bash
9398
sudo pacman -Syu
9499
sudo pacman -S gcc
95-
96100
```
97101
98-
## Mac
102+
## macOS
99103
100-
Ensure that Clang is installed by checking its version:
104+
Ensure that either clang or gcc is installed by checking their versions
101105
102106
```bash
103107
clang --version
108+
g++ --version
104109
```
105110
106-
If it's not installed, open "Terminal" and run the command:
111+
If neither is installed, open "Terminal" and run the following command:
107112
108113
```bash
109114
xcode-select --install
110115
```
111-
In the window that pops up, click "Install" and agree to the Terms of Service. Once the installation is complete, the command line utilities should be set up properly.
116+
In the window that appears, click "Install" and agree to the Terms of Service. Once the installation is complete, the command line utilities should be set up properly.
117+
118+
This ensures that clang is installed on your system.
119+
120+
You can then install `gcc` through [Homebrew](https://docs.brew.sh/Installation), a popular package management system for macOS. If you don't have Homebrew installed yet, you can do so with the following command:
121+
122+
```bash
123+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
124+
```
125+
126+
After installing Homebrew, use the following command to install g++:
127+
128+
```bash
129+
brew install gcc
130+
```
131+
132+
This will install the latest version of gcc, which includes the C++ (g++) compiler.
133+
134+
Verify that both compilers are installed correctly by running:
135+
136+
```bash
137+
clang --version
138+
g++ --version
139+
```
140+
141+
If you use Clang to compile your files, modify your Makefile to use it instead of c++.
112142
113-
Refer to the specific instructions for your operating system to install make and gcc successfully.
143+
Refer to the specific instructions for your operating system to install make and gcc successfully.

0 commit comments

Comments
 (0)