Skip to content

Commit 7ae5b7d

Browse files
committed
Updated README and did finishing touches.
1 parent fb6c45e commit 7ae5b7d

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,51 @@
1-
# PROG8051 Assign3
1+
# Vehicle Rental Management System - VRMS
2+
3+
Vehicle Rental Management System is a console-based application designed to manage a fleet of vehicles available for rental. Users can add vehicles to the fleet, remove vehicles, and rent them out to customers.
4+
5+
## Objective
6+
7+
The system's objective is to efficiently manage the rental process of vehicles while ensuring proper organization and tracking of the rental agency's inventory.
8+
9+
## Features
10+
11+
- **Vehicle Classes**: Three types of vehicles are supported: Cars, Trucks, and Motorcycles, each with specific properties and functionalities.
12+
- **Rental Agency**: Manages the fleet of vehicles, tracks total revenue earned, and provides methods to add, remove, and rent vehicles.
13+
- **Encapsulation**: Class properties and methods are appropriately encapsulated to maintain data integrity and hide internal implementation details.
14+
- **Abstraction**: Abstraction is utilized through method overriding to display specific details unique to each vehicle type while maintaining a consistent method signature.
15+
16+
## How to Use
17+
18+
1. **Clone the Repository:**
19+
```bash
20+
git clone https://github.com/EdisCode/PROG8051-Assign3.git
21+
```
22+
23+
2. **Navigate to the Project Directory:**
24+
```bash
25+
cd vehicle-rental-management
26+
```
27+
28+
3. **Compile and Run the Application:**
29+
```bash
30+
dotnet run
31+
```
32+
33+
4. **Follow On-screen Instructions:**
34+
- Use the application to manage the rental agency's fleet by adding, removing, and renting vehicles.
35+
- Enjoy exploring the functionalities of the Vehicle Rental Management System.
36+
37+
## Implementation Details
38+
39+
The system is implemented in C# and consists of the following classes:
40+
41+
- `Vehicle`: Represents a generic vehicle available for rental.
42+
- `Car`: Inherits from the Vehicle class and represents a car with additional properties.
43+
- `Truck`: Inherits from the Vehicle class and represents a truck with additional properties.
44+
- `Motorcycle`: Inherits from the Vehicle class and represents a motorcycle with additional properties.
45+
- `RentalAgency`: Manages the rental agency's fleet of vehicles, tracks total revenue, and provides methods for fleet management.
46+
47+
## Additional Notes
48+
49+
Feel free to explore and modify the codebase to adapt the Vehicle Rental Management System to your specific requirements or preferences.
50+
51+
Happy renting! 🚗💨

0 commit comments

Comments
 (0)