Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexwkleung committed Sep 3, 2022
1 parent 8f756ef commit e60d849
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Clone the repository.
git clone <SSH/HTTPS URL>
```

Go to the directory `TermStylist/include` and copy `termstylist.h` into your project.
Go to the directory `TermStylist/include` and copy `termstylist.h` into your project - preferrably in an `include` folder.

Include the header in your project.

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
```

**Alternatively:**
Expand All @@ -41,7 +41,7 @@ Include the header in your project.
5) Include the header in your project.

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
```

# Usage (Default Syntax)
Expand Down Expand Up @@ -203,7 +203,7 @@ You can access the objects' members via the dot operator (i.e., `termstylist::EO
**Attributes**

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -216,7 +216,7 @@ int main() {
**Foreground colours - 8/16 colours**

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -229,7 +229,7 @@ int main() {
**Background colours - 8/16 colours**

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -242,7 +242,7 @@ int main() {
**Foreground colours - 256 colours**

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -255,7 +255,7 @@ int main() {
**Background colours - 256 colours**

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -268,7 +268,7 @@ int main() {
**Accessing via objects (TermStylist syntax)**

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -279,7 +279,7 @@ int main() {
```

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

std::ostream &boldCyan(std::ostream &out) {
Expand All @@ -296,7 +296,7 @@ int main() {
```
```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>
#include <string>
Expand All @@ -318,7 +318,7 @@ int main() {
**Accessing via objects (Your own created object)**

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -332,7 +332,7 @@ int main() {
```

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -345,7 +345,7 @@ int main() {
```

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -358,7 +358,7 @@ int main() {
```

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand All @@ -372,7 +372,7 @@ int main() {
```

```cpp
#include "termstylist.h"
#include "include/termstylist.h"
#include <iostream>

int main() {
Expand Down

0 comments on commit e60d849

Please sign in to comment.