Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
angrezichatterbox authored Jul 18, 2024
1 parent 7c04bf8 commit b7db3e3
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# bunk_mate
Bunk-Mate

A new Flutter project.
Many of us have desired to take a day off from college for various activities or simply to relax, but often refrain due to concerns about meeting the attendance requirement percentage. The Bunk Mate app/website aims to address this dilemma by providing a convenient solution for tracking classes attended and offering live updates on the remaining classes needed to meet the attendance target.
## Installation

## Getting Started
Just download the latest ~[release apk](https://github.com/Bunk-Mate/Mobile-App/releases/latest/download/app-release.apk)~ and install!
## Usage

This project is a starting point for a Flutter application.
Here's how you can utilize the Attendance Tracker app effectively:
**1** **Create an Account**: Sign up for an account within the app.
**2** **Login**: Log in to your account that you just created.
**3** **Add Timetable**: The app will now prompt you to enter your timetable details. Provide details such as timetable name, start and end dates, and the required attendance percentage.
* You also have the option of selecting a timetable shared by other users
**4** **Manage Timetable**: Once your timetable is added, navigate to the courses page from the navigation bar to view and manage your courses and their schedules.
**5** **Update Attendance Status**: Update your attendance status on the status page. **Single-click to mark a day as bunked, double-click to mark as skipped, and deep-press to mark as present**. By default, days are marked as present, meaning that you only need to update it if you bunk a class or if it is skipped.

A few resources to get you started if this is your first Flutter project:
⠀For Developers

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
## Setup

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
To install the Attendance Tracker app, follow these simple steps:
1 Clone the repository to your local machine.
2 Run flutter run to install and launch the app.

0 comments on commit b7db3e3

Please sign in to comment.