Denarzai · Denarzai · Jul 4, 2026 · Jul 4, 2026
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,12 @@
+name: build
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Compile
+        run: g++ -std=c++11 -O2 -o osim-security-simulation src/*.cpp -Iinclude
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # OSIM Security Simulation
 
+[![build](https://github.com/Denarzai/Osim-Security-Simulation/actions/workflows/build.yml/badge.svg)](https://github.com/Denarzai/Osim-Security-Simulation/actions/workflows/build.yml)
+
 ## Project Overview
 OSIM Security Simulation is a C++ console application that models an internal organizational environment with role-based access control (RBAC). It was built for an Object-Oriented Programming university course and focuses on secure operational workflows such as authentication, authorization, task handling, communications, audit logging, and anomaly reporting.
 
@@ -13,16 +15,25 @@ The system uses five organizational roles with increasing clearance:
 Application state is persisted in text files (for example users, tasks, messages, notifications, audit logs, and performance data), so actions performed in the console menus are retained across runs.
 
 ## Class Design
-The full UML class diagram is in `finalUML.pdf` (source: `projuml.drawio`).
+The full UML class diagram is in `docs/finalUML.pdf` (source: `docs/projuml.drawio`).
 
-![Class diagram](class-diagram.png)
+![Class diagram](docs/class-diagram.png)
 
 ## Tech Stack
 - Language: C++
 - Standard libraries: iostream, string, ctime/cstdlib, fstream, iomanip, cstring
 - Architecture style: Object-Oriented Programming (classes, inheritance, managers/singletons)
-- Data storage: Plain text files in the project root
-- Platform target: Console application (Windows-compatible)
+- Data storage: Plain text files (sample data in `data/`)
+- Platform target: Console application (cross-platform; developed on Windows)
+
+## Repository Structure
+
+| Path | Contents |
+|------|----------|
+| `src/` | Implementation files (`.cpp`) |
+| `include/` | Headers (`.h`) |
+| `data/` | Sample data files the application reads and writes |
+| `docs/` | UML class diagram (PDF, draw.io source, PNG export) |
 
 ## Features
 - Authentication and RBAC
@@ -71,11 +82,11 @@ The full UML class diagram is in `finalUML.pdf` (source: `projuml.drawio`).
 ## How to Compile and Run
 The project does not include a build system file, so compile from source files directly.
 
-### Option 1: g++ (MinGW)
+### Option 1: g++
 From the project root:
 
 ```bash
-g++ -std=c++11 -O2 -o osim-security-simulation *.cpp
+g++ -std=c++11 -O2 -o osim-security-simulation src/*.cpp -Iinclude
 ./osim-security-simulation
 ```
 
@@ -89,11 +100,15 @@ On Windows PowerShell, run:
 From the project root:
 
 ```bat
-cl /EHsc /std:c++14 *.cpp
+cl /EHsc /std:c++14 /Iinclude src\*.cpp /Feosim-security-simulation.exe
 osim-security-simulation.exe
 ```
 
-Note: The application expects its text data files (such as users.txt, tasks.txt, inbox.txt, notification.txt, audit.txt, performanceLog.txt, preference.txt, anomalyLog.txt) in the same working directory.
+Note: The application reads and writes its text data files (users.txt, tasks.txt, inbox.txt, notification.txt, audit.txt, performanceLog.txt, preference.txt, anomalyLog.txt) in the current working directory. Sample data lives in `data/` — copy it next to the binary before the first run:
+
+```bash
+cp data/*.txt .
+```
 
 ## Role in Project
 Built as a pair project for a university OOP course.

diff --git a/anomalyLog.txt → data/anomalyLog.txt b/anomalyLog.txt → data/anomalyLog.txt
diff --git a/audit.txt → data/audit.txt b/audit.txt → data/audit.txt
diff --git a/inbox.txt → data/inbox.txt b/inbox.txt → data/inbox.txt
diff --git a/notification.txt → data/notification.txt b/notification.txt → data/notification.txt
diff --git a/performanceLog.txt → data/performanceLog.txt b/performanceLog.txt → data/performanceLog.txt
diff --git a/preference.txt → data/preference.txt b/preference.txt → data/preference.txt
diff --git a/tasks.txt → data/tasks.txt b/tasks.txt → data/tasks.txt
diff --git a/users.txt → data/users.txt b/users.txt → data/users.txt
diff --git a/class-diagram.png → docs/class-diagram.png b/class-diagram.png → docs/class-diagram.png
diff --git a/finalUML.pdf → docs/finalUML.pdf b/finalUML.pdf → docs/finalUML.pdf
diff --git a/projuml.drawio → docs/projuml.drawio b/projuml.drawio → docs/projuml.drawio
diff --git a/MFA.h → include/MFA.h b/MFA.h → include/MFA.h
diff --git a/anomaly.h → include/anomaly.h b/anomaly.h → include/anomaly.h
diff --git a/audit.h → include/audit.h b/audit.h → include/audit.h
diff --git a/dashboard.h → include/dashboard.h b/dashboard.h → include/dashboard.h
@@ -3,7 +3,7 @@
 #include "audit.h"
 #include "messageManager.h"
 #include "notificationManager.h"
-#include "perfomanceReview.h"
+#include "performanceReview.h"
 #include "policyEngine.h"
 #include "taskManager.h"
 #include "timeManager.h"

diff --git a/message.h → include/message.h b/message.h → include/message.h
diff --git a/messageManager.h → include/messageManager.h b/messageManager.h → include/messageManager.h
diff --git a/notification.h → include/notification.h b/notification.h → include/notification.h
diff --git a/notificationManager.h → include/notificationManager.h b/notificationManager.h → include/notificationManager.h
diff --git a/pch.h → include/pch.h b/pch.h → include/pch.h
diff --git a/perfomanceReview.h → include/performanceReview.h b/perfomanceReview.h → include/performanceReview.h
diff --git a/policyEngine.h → include/policyEngine.h b/policyEngine.h → include/policyEngine.h
diff --git a/task.h → include/task.h b/task.h → include/task.h
diff --git a/taskManager.h → include/taskManager.h b/taskManager.h → include/taskManager.h
diff --git a/timeManager.h → include/timeManager.h b/timeManager.h → include/timeManager.h
diff --git a/user.h → include/user.h b/user.h → include/user.h
@@ -1,7 +1,7 @@
 #pragma once
 #include "pch.h"
 #include "utilities.h"
-#include "perfomanceReview.h"
+#include "performanceReview.h"
 
 class User {
 protected:

diff --git a/userManager.h → include/userManager.h b/userManager.h → include/userManager.h
diff --git a/utilities.h → include/utilities.h b/utilities.h → include/utilities.h
diff --git a/MFA.cpp → src/MFA.cpp b/MFA.cpp → src/MFA.cpp
diff --git a/anomaly.cpp → src/anomaly.cpp b/anomaly.cpp → src/anomaly.cpp
diff --git a/audit.cpp → src/audit.cpp b/audit.cpp → src/audit.cpp
diff --git a/dashboard.cpp → src/dashboard.cpp b/dashboard.cpp → src/dashboard.cpp
diff --git a/main.cpp → src/main.cpp b/main.cpp → src/main.cpp
diff --git a/message.cpp → src/message.cpp b/message.cpp → src/message.cpp
diff --git a/messageManager.cpp → src/messageManager.cpp b/messageManager.cpp → src/messageManager.cpp
diff --git a/notification.cpp → src/notification.cpp b/notification.cpp → src/notification.cpp
diff --git a/notificationManager.cpp → src/notificationManager.cpp b/notificationManager.cpp → src/notificationManager.cpp
diff --git a/perfomanceReview.cpp → src/performanceReview.cpp b/perfomanceReview.cpp → src/performanceReview.cpp
@@ -1,4 +1,4 @@
-#include "perfomanceReview.h"
+#include "performanceReview.h"
 
 PerformanceReview::PerformanceReview(string n, string r)
     : name(n), role(r), tasksCompleted(0), tasksOverdue(0),

diff --git a/policyEngine.cpp → src/policyEngine.cpp b/policyEngine.cpp → src/policyEngine.cpp
diff --git a/task.cpp → src/task.cpp b/task.cpp → src/task.cpp
diff --git a/taskManager.cpp → src/taskManager.cpp b/taskManager.cpp → src/taskManager.cpp
diff --git a/timeManager.cpp → src/timeManager.cpp b/timeManager.cpp → src/timeManager.cpp
diff --git a/user.cpp → src/user.cpp b/user.cpp → src/user.cpp
diff --git a/userManager.cpp → src/userManager.cpp b/userManager.cpp → src/userManager.cpp
diff --git a/utilities.cpp → src/utilities.cpp b/utilities.cpp → src/utilities.cpp