Merge pull request #67 from COS301-SE-2024/update/documentation

Update/documentation
COS301-SE-2024 · Jun 21, 2024 · e50dbb0 · e50dbb0
2 parents 81e32dc + fbbca12
commit e50dbb0
Showing 1 changed file with 46 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -1,54 +1,73 @@
-
 <div align="center">
 <h1>ClassConnect</h1>
+  <img src="./resources/images/class-connect-logo.png" alt="class-connect logo"/>
+
+  [![Issue Tracking](https://img.shields.io/badge/Issue_Tracking-GitHub_Issues-yellow)](https://github.com/COS301-SE-2024/ClassConnect/issues)
+  [![Build Status](https://img.shields.io/badge/Build_Status-GitHub_Actions-brightgreen)](https://github.com/COS301-SE-2024/ClassConnect/actions/workflows/linter.yml)
+  [![codecov](https://codecov.io/github/COS301-SE-2024/ClassConnect/graph/badge.svg?token=W2cOxCJT1g)](https://codecov.io/github/COS301-SE-2024/ClassConnect)
+  ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m797015486-75c486778a8f87b141372bd7)
+
+  <hr>
+</div>
+<h2>📄 Description</h2>
 
-<img src="./resources/images/class-connect-logo.png" alt="class-connect logo" />
-
-[![Issue Tracking](https://img.shields.io/badge/Issue_Tracking-GitHub_Issues-yellow)](https://github.com/COS301-SE-2024/ClassConnect/issues) [![Build Status](https://img.shields.io/badge/Build_Status-GitHub_Actions-brightgreen)](https://github.com/COS301-SE-2024/ClassConnect/actions/workflows/linter.yml) [![codecov](https://codecov.io/github/COS301-SE-2024/ClassConnect/graph/badge.svg?token=W2cOxCJT1g)](https://codecov.io/github/COS301-SE-2024/ClassConnect) ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m797015486-75c486778a8f87b141372bd7)
+ClassConnect is an innovative educational platform that blends the traditional learning hub with a 3D learning environment. Its primary objective is to leverage cutting-edge and emerging 3D technologies to enrich learning experiences. This is achieved by enabling students to interact with 3D models that correspond to their study material. This interactive approach not only fosters a deeper understanding of the subject matter but also ensures that the learning experience is memorable. In essence, ClassConnect is revolutionising education by making learning more immersive and engaging.
 
-</div>
+<h2>📁 Documentation</h2>
+<details>
+  <summary>
+    Services Requirement Specification (SRS)
+  </summary>
 
-## 📄 Description
+  - [SRS Document V1](https://drive.google.com/file/d/1_EG2l7GWTb_-C0pbum3-EAEQ1Ve1242p/view?usp=sharing)
+  - [SRS Document V2]()
+</details>
 
-ClassConnect is an innovative educational platform that blends the traditional learning
-hub with a 3D learning environment. Its primary objective is to leverage cutting-edge
-and emerging 3D technologies to enrich learning experiences. This is achieved by
-enabling students to interact with 3D models that correspond to their study material.
-This interactive approach not only fosters a deeper understanding of the subject matter
-but also ensures that the learning experience is memorable. In essence, ClassConnect
-is revolutionising education by making learning more immersive and engaging.
+<details>
+  <summary>
+    Additional Documentation
+  </summary>
 
-## 📁 Documentation
+  - [Coding Standards]()
+  - [Testing Policy]()
+  - [Architecture Document]()
+  - [Contributions]()
+</details>
 
-- [SRS Document](https://drive.google.com/file/d/1_EG2l7GWTb_-C0pbum3-EAEQ1Ve1242p/view?usp=sharing)
+<h2>🎬 Demo Videos</h2>
 
-## 🎬 Demo Video
+<details>
+  <summary>
+    Demo Videos
+  </summary>
 
-- [Demo 1 Video](https://drive.google.com/file/d/1AJAgftIAKCBaGVa4KQGHvoX01R3dvBUb/view?usp=sharing)
+  - [Demo 1 Video](https://drive.google.com/file/d/1AJAgftIAKCBaGVa4KQGHvoX01R3dvBUb/view?usp=sharing)
+  - [Demo 2 Video]()
+</details>
 
-## 🔧 Technologies
 
-<p align="center">
+<h2>🔧 Technologies</h2>
+<p">
     <a href="https://skillicons.dev">
         <img src="https://skillicons.dev/icons?i=svelte,vite,tailwind,threejs,nestjs,bun,mongodb,vercel,figma,blender&perline=10" />
     </a>
 </p>
 
-## 📋 Project Management
+<h2>📋 Project Management</h2>
 
 [Project Board](https://github.com/orgs/COS301-SE-2024/projects/80)
 
-## 👥 Team Members
+<h2>👥 Team Members</h2>
 
 | Name           | Profile Picture                                                                                                    | Role              | Socials                                                                                                                                                                                           |
 | -------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **Joshua Wereley** | <img src="./resources/images/joshua.jpeg" alt="Joshua's Profile Picture" width="200" height="200"> | Project Manager   | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
-| **Ashley Kapaso**  | <img src="./resources/images/ashley.jpeg" alt="Ashley's Profile Picture" width="200" height="200"> | Architect         | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
-| **Eugene Mpande**  | <img src="./resources/images/eugene.jpeg" alt="Eugene's Profile Picture" width="200" height="200"> | DevOps Engineer   | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
-| **Lunga Ndlovu**   | <img src="./resources/images/lunga.jpeg" alt="Lunga's Profile Picture" width="200" height="200">   | Frontend Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
-| **Ayanda Juqu**    | <img src="./resources/images/ayanda.jpeg" alt="Ayanda's Profile Picture" width="200" height="250"> | Backend Engineer  | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
+| **Joshua Wereley** | <img src="./resources/images/joshua.jpeg" alt="Joshua's Profile Picture" width="200"> | Project Manager   | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
+| **Ashley Kapaso**  | <img src="./resources/images/ashley.jpeg" alt="Ashley's Profile Picture" width="200"> | Architect         | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
+| **Eugene Mpande**  | <img src="./resources/images/eugene.jpeg" alt="Eugene's Profile Picture" width="200"> | DevOps Engineer   | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
+| **Lunga Ndlovu**   | <img src="./resources/images/lunga.jpeg" alt="Lunga's Profile Picture" width="200">   | Frontend Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
+| **Ayanda Juqu**    | <img src="./resources/images/ayanda.jpeg" alt="Ayanda's Profile Picture" width="200"> | Backend Engineer  | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
 
-## ✉️ Contact
+<h2>✉️ Contact</h2>
 
 ### phantomworks.capstone@gmail.com