Skip to content

Commit 9794b2e

Browse files
authored
Enhance README with project overview and structure
Added overview section and updated project structure.
1 parent 44bd3d4 commit 9794b2e

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Project 0 – Two Sum (C++)
22

3+
## 📌 Overview
4+
5+
This repository contains the implementation of Project 0 for CS351, focusing on solving the Two Sum problem using both brute-force and optimized approaches.
6+
7+
The project demonstrates algorithmic thinking, performance comparison, and clean C++ project structure.
8+
39
## 📌 Objective
410
The goal of this project is to implement and compare two different approaches to solve the classic "Two Sum" problem, focusing on algorithmic complexity and performance.
511

@@ -33,12 +39,13 @@ Given an array of integers `nums` and an integer `target`, return the indices of
3339
## 📂 Project Structure
3440

3541
```
36-
Project0/
42+
11402_CS351_Project0/
3743
38-
├── include/ # Header files
3944
├── src/ # Source code
45+
├── include/ # Header files
4046
├── tests/ # Unit tests
41-
├── docs/ # Additional documentation
47+
├── docs/ # Reports & documentation
48+
├── .github/ # CI workflow
4249
└── README.md
4350
```
4451

@@ -80,6 +87,7 @@ Project0/
8087

8188
## ▶️ How to Run
8289

90+
### Run unit tests
8391
```bash
8492
g++ -Iinclude src/twosum.cpp tests/test_twosum.cpp -o test
8593
./test

0 commit comments

Comments
 (0)