Update README.md

README.md

@@ -1,22 +1,100 @@
+# Chronos - Timetable Builder
+![Chronos Logo](https://github.com/KrishPatel13/Chronos/blob/main/Chronos%20Logo.png)
 
+Chronos is a flexible time management tool designed to help students strike and maintain a healthy work-life balance while remaining adaptable to changing situations. By blending life-gamification and motivational aspects with schedule-making functionality, Chronos provides a unique approach to managing time effectively and achieving goals.
 
+## Project Overview
 
-![Chronos Logo](https://github.com/KrishPatel13/Chronos/blob/main/Chronos%20Logo.png)
+**Chronos** was developed as a part of the CSC207 course project by "The Hamburglars" team. The project was created with the intention of encouraging goal accomplishment and enabling simple adjustment of schedules. It offers a calendar system that allows users to set up, modify, and track events, along with the ability to design self-awarded prizes upon achieving specific goals.
+
+### Key Features
+
+- **Flexible Calendar System**: Set up events that can be modified later using a user-friendly interface.
+- **Goal Setting and Tracking**: Users can create goals associated with events and track their progress.
+- **Life-Gamification**: Design rewards for yourself that are only awarded if specific events are fulfilled, promoting a balanced lifestyle.
+- **Accessibility Features**: Customize the application's background and font colors to suit your preferences, ensuring a more accessible user experience.
+
+## Team Members
+
+1. **Jacob Youssef** - Focused on goal tracking and rewards system.
+2. **Krish Patel** - Implemented event creation and scheduling functionality.
+3. **Shivank Goel** - Developed accessibility features for the application.
+4. **Khubaib Ahmed** - Designed the calendar interface and event display.
+
+## Development Process
+
+### Sprint 1
+
+- **Objective**: Implement the core functionality, including event creation, calendar view, and basic accessibility features.
+- **Completed Tasks**:
+  - Event creation system.
+  - Calendar view (without drag-and-drop due to time constraints).
+  - Goal setting and reward system.
+  - Initial accessibility features for color customization.
+
+### Sprint 2
+
+- **Objective**: Finalize the minimum viable product by completing the remaining features.
+- **Completed Tasks**:
+  - Enhanced accessibility options.
+  - Editing and displaying events in the calendar.
+  - Save and load feature for user progress.
+  - Refined user interface for better usability.
+
+## Installation and Usage
+
+### Prerequisites
+
+- **Java Development Kit (JDK)**: Ensure you have JDK 8 or higher installed on your machine.
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/KrishPatel13/The-Hamburglars.git
+cd The-Hamburglars
+```
+
+### Compile and Run
+
+1. **Compile the Project**:
+    ```bash
+    javac -cp src src/chronos/*.java
+    ```
+
+2. **Run the Application**:
+    ```bash
+    java -cp src chronos.Main
+    ```
+
+### Features to Explore
+
+- **Create and Edit Events**: Set up events in the calendar and modify them as needed.
+- **Track Goals**: Create goals and associate them with specific events to track your progress.
+- **Customize Appearance**: Adjust the application's background and font colors for a personalized experience.
+- **Save and Load Progress**: Your progress is automatically saved, allowing you to pick up where you left off.
+
+## Future Enhancements
+
+- **Drag-and-Drop Event Management**: Enable users to drag and drop events within the calendar for easier scheduling.
+- **Screen Reader Support**: Improve accessibility by adding screen reader functionality.
+- **Visual Enhancements**: Increase the font size of list items and represent events more visually on the calendar.
+
+## Contribution
+
+If you would like to contribute to Chronos, please fork the repository and submit a pull request. We welcome all suggestions and improvements!
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Acknowledgments
+
+Special thanks to our professor and TA Jovana for their continuous support and guidance throughout the project.
 
-"Chronos" was developed with the intention of creating a flexible time manage-
-ment tool that encourages goal accomplishment and enables for simple adjustment.
-Chronos is designed for students who need assistance in striking and maintaining a
-healthy work-life balance while remaining adaptable to changing situations.
+## Contact
 
-Chronos’ calendar system will meet this demand by enabling users to set up events
-that can be modified later. Chronos will allow users to design prizes for themselves
-that will only be "awarded" if specific events are fulfilled, further encouraging work-
-life balance. This will help users remember to take time for themselves and prevent
-burnout from relentlessly grinding.
+For any questions or feedback, please reach out via the GitHub repository's issues section.
 
-Users will find Chronos useful since the project blends life-gamification and moti-
-vational aspects with the schedule-making functionality of other applications like
-Notion. Chronos will assist users in maintaining a healthy work-life balance and de-
-veloping themselves along the way by merging the two aspects and generalising their
-application to any issue like school or exercise.
+---
 
+**The Hamburglars** - CSC207 Project - University of Toronto