Skip to content

Commit 42a4ed6

Browse files
Update README.md
1 parent b85d4d9 commit 42a4ed6

1 file changed

Lines changed: 44 additions & 25 deletions

File tree

README.md

Lines changed: 44 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# 🎓 NFC Projects BS AI Journey
1+
# NFC Projects BS Artificial Intelligence Journey
22

3-
This repository contains my **semester-wise projects** from my BS in Artificial Intelligence at **NFC Institute of Engineering & Technology (NFC IET), Multan** (2k24-28).
3+
This repository contains my semester-wise projects from my BS in Artificial Intelligence
4+
at **NFC Institute of Engineering & Technology (NFC IET), Multan** (2024–2028).
45

5-
It serves as a collection of all small and large projects completed during my degree, showcasing my **learning progress, coding skills, and subject applications**.
6+
It serves as a structured record of all projects completed throughout my degree,
7+
reflecting my learning progress, problem-solving approach, and practical application
8+
of core Computer Science and AI concepts.
69

710
---
811

9-
## 📂 Repository Structure
12+
## Repository Structure
1013

1114
```txt
1215
NFC-Projects/
@@ -18,58 +21,74 @@ NFC-Projects/
1821
│ └── README.md
1922
2023
├── .github/
21-
| └── workflows/
24+
└── workflows/
2225
│ └── syntax-check.yml
23-
|
24-
└── README.md (this file)
26+
27+
└── README.md (this file)
2528
```
2629

2730
---
2831

29-
## 🎯 Purpose
32+
## Purpose
33+
34+
This repository exists to:
3035

31-
- Track and store all **university projects**
32-
- Showcase my **AI + CS journey** step by step
33-
- Collaborate with friends and share learning
34-
- Build a **portfolio** for the future
36+
- Keep all university projects organized in one place
37+
- Document my growth as an AI and software developer semester by semester
38+
- Collaborate with classmates and share knowledge openly
39+
- Gradually build a portfolio that reflects real, hands-on work
3540

3641
---
3742

38-
## 🤝 Contribution
43+
## Projects Overview
3944

40-
Some projects were developed **solo**, others in **collaboration with friends**.
45+
Each project lives in its own folder with a dedicated `README.md` that covers:
4146

42-
Each project folder includes its own `README.md` with details like:
43-
- Semester & course
44-
- Features & concepts used
45-
- How to run
47+
- The semester and course it belongs to
48+
- The core concept or data structure being demonstrated
49+
- Features implemented and technologies used
50+
- Instructions to run the project locally
51+
52+
Some projects were built independently. Others were developed in collaboration
53+
with fellow students, and credit is given where applicable.
4654

4755
---
4856

49-
## 🚀 How to Run
57+
## Getting Started
58+
59+
Clone the repository to your local machine:
5060

51-
Clone this repository:
5261
```bash
5362
git clone https://github.com/Muawiya-contact/NFC-Projects.git
5463
cd NFC-Projects
5564
```
5665

57-
Navigate to any project folder and run it. Example:
66+
Then navigate into any project folder and follow its README. For example:
67+
5868
```bash
5969
cd SearchEngine
6070
python main.py
6171
```
6272

6373
---
6474

65-
## 🌱 More Coming Soon
75+
## Continuous Integration
6676

67-
This repo will keep growing as I learn and build more. Stay tuned for new projects each semester!
77+
This repository uses a GitHub Actions workflow (`.github/workflows/syntax-check.yml`)
78+
to automatically check Python syntax on every push, keeping the codebase clean
79+
and error-free from the start.
6880

6981
---
7082

71-
## 📫 Contact
83+
## Progress & Roadmap 🌱
7284

73-
For collaboration or questions, reach out via [GitHub](https://github.com/Muawiya-contact).
85+
This repository is actively maintained and will grow each semester as new projects
86+
are added. Topics will expand from foundational data structures into machine learning,
87+
deep learning, NLP, and beyond as the degree progresses.
7488

7589
---
90+
91+
## Contact
92+
93+
For questions, feedback, or collaboration opportunities, feel free to reach out
94+
via [GitHub](https://github.com/Muawiya-contact).

0 commit comments

Comments
 (0)