Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thisisashwinraj authored Aug 26, 2024
1 parent 1e7f9e7 commit a565133
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ The project development started in April 2022 as a group project and has been li
<br>
**Ticketing Machine:** This directory contains the Python3 code for designing the hand-held ticketing machine, and DB

All relevant updates, and stable versions are made available in the [~/stableVersion](https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/tree/main/template_files/stable_versions) sub-directory. Some subdirectories may be sensitive for the project and may trigger review requests, when pull requests touch these files. Github handles with commit rights made available in the [~/Template Files/CODEOWNERS](https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/blob/main/template_files/CODEOWNERS) are responsible for reviewing such changes
<p align = "justify">
All relevant updates, and stable versions are made available in the <a href="https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/tree/main/template_files/stable_versions">~/stableVersion</a> sub-directory. Some subdirectories may be sensitive for the project and may trigger review requests, when pull requests touch these files. Github handles with commit rights made available in the <a href="https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/blob/main/template_files/CODEOWNERS">~/Template Files/CODEOWNERS</a> are responsible for reviewing such changes
</p>

# User Installation and Working
<p align = "justify">
CroMa is a firmware solution that provides commuters with real-time information about public transits(such as buses) including real-time tracking, estimated time-of-arrival and the seat occupancy. This solution is an interworking of two major components: a [handheld ticketing machine](https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/tree/main/hardware_files) and a <a href="https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/tree/main/android">mobile application</a>. CroMa v1.0 offers support for only buses.
CroMa is a firmware solution that provides commuters with real-time information about public transits(such as buses) including real-time tracking, estimated time-of-arrival and the seat occupancy. This solution is an interworking of two major components: a <a href="https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/tree/main/hardware_files">handheld ticketing machine</a> and a <a href="https://github.com/thisisashwinraj/CroMa-Crowd-Management-System/tree/main/android">mobile application</a>. CroMa v1.0 offers support for only buses.
</p>
<p align = "justify">
The hand-held ticketing machine is a micro-controller-based system used for generating billing tickets and collecting, saving, and generating daily reports and summaries. Our version of the hardware is additionally equipped with a GPS module for tracking the location of the bus. The device is to be used by conductors, and/or clippies for issuing tickets to the passengers. When new passengers board this bus, their details such as their start location, total luggage in the bus, their intended destination, & the total number of passengers is collected for issuing the tickets. These details are collected, processed and transmitted to the <a herf="https://firebase.google.com/products/realtime-database">FireBase RT database</a> by the hand-held ticketing machine. For passengers using a monthly, or yearly bus pass, a QR code or a unique alphanumerical code may be used to update the software.
Expand Down Expand Up @@ -64,7 +66,7 @@ CroMas development take place on [GitHub](https://github.com/thisisashwinraj/Cro
└── .mailmap
```

<p align='justify'>To run the application, start debugging by clicking <B>Run > Start Debugging</B> from the main IDE window (or press F5). If you are using <a href='https://code.visualstudio.com/'>VS Code</a>, you should see a set of Flutter-specific entries in the status bar, including a <a href='https://docs.flutter.dev/get-started/install'>Flutter SDK</a> version and a device name (or a message displaying No Devices). The Flutter extension automatically selects the latest device connected. However, if you have multiple devices/simulators connected, click device in the status bar to see a pick-list at the top of the screen. Select the device, you want to use for running, or debugging, and finally, run this application.</p>
<p align='justify'>To run the application, start debugging by clicking <B>Run > Start Debugging</B> from the main IDE window (or press F5). If you are using <a href='https://code.visualstudio.com/'>VS Code</a>, you should see a set of Flutter-specific entries in the status bar, including a <a href='https://docs.flutter.dev/get-started/install'>Flutter SDK</a> version and a device name (or a message displaying No Devices). The Flutter extension automatically selects the latest device connected. However, if you have multiple devices/simulators connected, click device in the status bar to see a pick-list at the top of the screen. Select the device you want to use for running or debugging and finally, run this application.</p>

# CroMa - Under the Hood

Expand Down

0 comments on commit a565133

Please sign in to comment.