Docs cleanup: MIT license, accurate root README, human-toned project READMEs by Muawiya-contact · Pull Request #24 · Coding-Moves/BSAI-Projects

Muawiya-contact · 2026-08-30T18:53:18Z

Summary

Documentation review pass across the whole repo. Every change is its own commit so each can be reviewed (or reverted) independently — 13 commits total.

Changes, one per commit

Add MIT LICENSE file — the repo is meant to be open source under MIT but had no license file at all, so the license was unenforceable. Added the standard MIT text.
Rewrite root README — it still called the repo NFC-Projects, listed folders that no longer exist (PhoneBook-HashTable), omitted most of the actual projects, and pointed the clone URL at the wrong repo. Now it's a short, accurate index of all 10 projects with correct links, a license section, and a note that AI assistance was used.
CI workflow fix — the syntax check only ran on pull requests while the README claimed it runs on every push. Added the push trigger, bumped actions/checkout to v4 and setup-python to v5, and dropped end-of-life Python 3.8/3.9 from the matrix. Verified the check passes locally against the current tree.
SearchEngine README — 145 → ~50 lines; fixed stale claims (GPT answers go to numbered gpt_N.txt files, all query words must match, API key required at startup).
Smart-Home-Simulator README — 159 → ~53 lines; verified against controller.py and smart_light_server.py.
Stocks Trend Analyzer README — 155 → ~51 lines; fixed the wrong folder layout and added the missing customtkinter dependency.
AcadAI README — corrected the model description (Random Forest + Linear Regression, not Ridge), the dataset size (30 students, not 60), and removed an unverifiable accuracy claim.
MSMS README — 340 → ~73 lines; kept the full setup/database/run instructions and default login, cut the project-tree dump, API endpoint tables, and schema tables.
CloudKernel README — 130 → ~67 lines; added Linux/macOS run commands alongside the PowerShell ones, dropped a stale file listing.
RC+ README — pin mapping, AP credentials, and control flow now verified against the actual sketch.
IoT_IDS README — the old README documented code files that don't exist; the folder only contains the proposal PDF, and the README now says so honestly.
ResQTemp README — the old README described Arduino UNO + main.asm + SIM900A; the actual code is an ESP8266 sketch with GSM AT-command alerts and a web dashboard. Rewritten to match reality.
SFS README — corrected the manage.py path, removed a step referencing a nonexistent .env.example, deleted a duplicated marketing section that didn't match the Django backend.

Style applied throughout

Small and descriptive: each README is now 35–75 lines instead of 100–340.
Human-toned: no emoji headings, no checkmark walls, no marketing adjectives.
Honest: every technical claim was verified against the actual code; stale or invented claims were fixed or removed, and AI assistance is acknowledged in the root README.

Verification

python -m py_compile over every .py file passes locally (same check as CI).
All README claims cross-checked against the files in each project folder.

🤖 Generated with Claude Code

The repository is meant to be open source under MIT but had no license file, so the license was legally unenforceable. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

The old README still described the repo as NFC-Projects, listed folders that no longer exist (PhoneBook-HashTable), omitted most of the actual projects, and pointed the clone URL at the wrong repo. Replaced it with a short accurate project index, correct clone URL, a license section, and a note that AI assistance was used. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

The workflow only triggered on pull requests while the README said it runs on every push; added the push trigger. Bumped checkout to v4 and setup-python to v5, and dropped end-of-life Python 3.8/3.9 from the matrix. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Cut from 145 to ~50 lines. Fixed inaccuracies: GPT answers are saved to numbered gpt_N.txt files (not a single gpt.txt), all query words must match, and an API key is required at startup. Dropped the emoji checkmark walls, the long example session, and the future-work list. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Cut from 159 to ~53 lines, verified against controller.py and smart_light_server.py. Kept the description, setup commands, demo link, and course/author credits; dropped the emoji-heavy marketing tone. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Cut from 155 to ~51 lines. Fixed the wrong folder layout and added the missing customtkinter dependency (verified against main.py's actual imports). Kept per-module explanation and team credits. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Cut from 105 to ~44 lines. Corrected the model description (Random Forest + Linear Regression, not Ridge), the generated dataset size (30 students, not 60), and removed the unverifiable ~91% accuracy claim and a placeholder clone URL. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Kept accurate setup, database import order, run instructions, ports, and default login. Cut the full project tree dump, API endpoint tables, 12-table schema table, and screenshots placeholder — detail that belongs in the code and docs/ folder, not the README. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Cut from 130 to ~67 lines. Kept the concurrency model, config, and build/run steps (added a Linux/macOS equivalent to the PowerShell commands); dropped emoji headings and a stale file listing. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Cut from 135 to ~67 lines. Pin mapping, AP credentials, and control flow now match the actual sketch and interface files. Kept team credits and links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

The old README listed code files that don't exist in the folder — it currently contains only the project proposal PDF. The README now says so honestly instead of documenting phantom code. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

The old README described an Arduino UNO + main.asm + SIM900A setup; the code is an ESP8266 sketch (assembly/esp.c++) with a 33 °C threshold, GSM AT-command alerts, and a web dashboard. Kept course, instructor, and team credits. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Corrected the manage.py path (backend/backend/sfs_backend), removed a setup step for a nonexistent .env.example, and deleted a duplicated Vercel/Netlify/Gemini marketing section that didn't match the Django backend. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Muawiya-contact

Inline notes on each change in this docs cleanup pass — one comment per file explaining what was fixed and why.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -0,0 +1,21 @@
+MIT License


New file. The repo was described as MIT/open source but had no license file anywhere, which means it effectively wasn't open source — without a license text, nobody has legal permission to reuse the code. Standard MIT text, copyright 2024–2026 to match the degree timeline.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -1,94 +1,38 @@
-# NFC Projects — BS Artificial Intelligence Journey
+# BSAI Projects


Full rewrite. The old README was stale on four counts: it still called the repo NFC-Projects, listed a PhoneBook-HashTable/ folder that doesn't exist, omitted 8 of the 10 actual projects, and the clone URL pointed at Muawiya-contact/NFC-Projects instead of this repo. Now: accurate 10-project index with verified one-line descriptions, correct clone URL, license section, and an honest note that AI assistance was used.

Muawiya-contact · 2026-08-30T18:55:33Z

 name: Python Syntax Check

 on:
+  push:


Added the push trigger. The workflow only ran on pull requests, while the root README claimed syntax checks run on every push — direct pushes to main were never checked. Also bumped actions/checkout v3→v4 and setup-python v4→v5, and dropped Python 3.8/3.9 from the matrix (both past end-of-life). Verified py_compile passes over every .py file in the current tree.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -1,146 +1,51 @@
-# 🔍 Mini Search Engine with Stack 
+# Mini Search Engine with Stack


Trimmed 145 → ~50 lines and fixed stale claims: GPT answers are saved to numbered gpt_N.txt files (not a single gpt.txt), matching requires all query words, and the OpenAI API key is required at startup. Dropped the emoji/checkmark walls, the 40-line example session, and the future-improvements list.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -1,158 +1,57 @@
-# 🏠 Smart Home Simulator 🔦 | Powered by Python OOP + Flask + IoT
+# Smart Home Simulator


Trimmed 159 → ~53 lines, verified against controller.py and smart_light_server.py. Kept the description, setup commands, demo link, and course/author credits; dropped the marketing tone ("creative and fully functional") and emoji headers.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -1,129 +1,67 @@
 # CloudKernel


Trimmed 130 → ~67 lines. Kept the concurrency model, config, and build/run steps, and added Linux/macOS equivalents next to the PowerShell-only commands. Dropped emoji headings and a stale file listing.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -1,135 +1,67 @@
 # CodingMoves-RC+


Verified against the sketch: pin mapping, AP credentials, and control flow now come from the actual .ino/interface files rather than the generic text. Team credits and links kept. 135 → ~67 lines.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -1,130 +1,34 @@
-# IoT Intrusion Detection System (Information Security Project)
+# IoT Intrusion Detection System


Honesty fix. The old README documented code files (ids.py etc.) that don't exist in this folder — it only contains the project proposal PDF. The README now describes what's actually here instead of phantom code, so nobody clones it expecting a runnable IDS.

Muawiya-contact · 2026-08-30T18:55:33Z

- [📧 Email](mailto:contactmuawia@gmail.com)
-
---
+# ResQTemp


Rewritten to match the actual hardware. The old README described an Arduino UNO + main.asm + SIM900A setup; the code in assembly/esp.c++ targets an ESP8266 with a 33 °C threshold, GSM AT-command alerts, and a web dashboard. Course, instructor, and team credits kept.

Muawiya-contact · 2026-08-30T18:55:33Z

@@ -1,140 +1,63 @@
-
 # Secure File System (SFS)


Fixed broken setup instructions: manage.py actually lives under backend/backend/sfs_backend, and the .env.example step referenced a file that doesn't exist. Also deleted a duplicated Vercel/Netlify/Gemini marketing section that didn't match this Django + DRF backend at all.

Muawiya-contact

Good

Muawiya-contact and others added 13 commits August 30, 2026 23:50

Add MIT LICENSE file

a895522

The repository is meant to be open source under MIT but had no license file, so the license was legally unenforceable. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

RC+: trim README, verify pins against the sketch

b74c502

Cut from 135 to ~67 lines. Pin mapping, AP credentials, and control flow now match the actual sketch and interface files. Kept team credits and links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Muawiya-contact commented Aug 30, 2026

View reviewed changes

Muawiya-contact merged commit e5bbbbf into main Aug 30, 2026
3 checks passed

Muawiya-contact deleted the docs/cleanup branch August 30, 2026 18:58

Navigation Menu

Uh oh!

Docs cleanup: MIT license, accurate root README, human-toned project READMEs - #24

Docs cleanup: MIT license, accurate root README, human-toned project READMEs#24
Muawiya-contact merged 13 commits into
mainfrom
docs/cleanup

Muawiya-contact commented Aug 30, 2026

Uh oh!

Muawiya-contact left a comment

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact Aug 30, 2026

Uh oh!

Muawiya-contact left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		@@ -1,94 +1,38 @@
		# NFC Projects — BS Artificial Intelligence Journey
		# BSAI Projects

		@@ -1,146 +1,51 @@
		# 🔍 Mini Search Engine with Stack
		# Mini Search Engine with Stack

		@@ -1,158 +1,57 @@
		# 🏠 Smart Home Simulator 🔦 \| Powered by Python OOP + Flask + IoT
		# Smart Home Simulator

		@@ -1,130 +1,34 @@
		# IoT Intrusion Detection System (Information Security Project)
		# IoT Intrusion Detection System

Uh oh!

Conversation

Muawiya-contact commented Aug 30, 2026

Summary

Changes, one per commit

Style applied throughout

Verification

Uh oh!

Muawiya-contact left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Muawiya-contact left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant