updated readme

README.md

@@ -1,36 +1,72 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-## Getting Started
+# Semester Subject Selector
 
-First, run the development server:
+## Description
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+This project is a React-based web application designed to help students, particularly those from MIT (DBATU), select and manage their backlog subjects across different semesters. It allows users to choose subjects, calculates total credits, and provides visual and audio feedback based on the credit load.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Features
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+- Semester selection dropdown
+- Subject checkboxes for each semester
+- Real-time credit calculation
+- Visual feedback (image changes based on credit load)
+- Audio feedback (sound plays when credit load changes)
+- List of selected subjects
+- Clear selection button
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+## Technologies Used
 
-## Learn More
+- React
+- Next.js
+- TypeScript
+- Tailwind CSS
 
-To learn more about Next.js, take a look at the following resources:
+## Installation
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+1. Clone the repository:
+   ```
+   git clone https://github.com/Sha1kh4/yd-checker.git
+   ```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+2. Navigate to the project directory:
+   ```
+   cd yd-checker
+   ```
 
-## Deploy on Vercel
+3. Install dependencies:
+   ```
+   npm install
+   ```
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+4. Run the development server:
+   ```
+   npm run dev
+   ```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+5. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+## Usage
+
+1. Select a semester from the dropdown menu.
+2. Check the boxes next to the subjects you want to select.
+3. The total credits will be calculated automatically.
+4. An image will display indicating whether your credit load is manageable.
+5. A sound will play when the credit load changes significantly.
+6. Use the "Clear Selections" button to reset your choices.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is open source and available under the [MIT License](LICENSE).
+
+## Credits
+
+Developed by SKAD for MIT Batu final year students.
+
+## Contact
+
+For any queries, please contact Shaikh Adnan at [email protected].