Skip to content

Commit 28ae0d8

Browse files
Feat: Updated README.md and added images used in it.
1 parent 200828a commit 28ae0d8

File tree

5 files changed

+29
-12
lines changed

5 files changed

+29
-12
lines changed

Travel_Itinerary_Planner/README.md

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
# Script Name
2-
Short description of package/script
3-
- If package, list of functionalities/scripts it can perform
4-
- If standalone script, short description of script explaining what it achieves
5-
6-
# Description
7-
- If code is not explainable using comments, use this sections to explain your script
1+
# Travel Itinerary Planner
2+
This application lets you add, edit, view and delete itineraries from a CLI/terminal.
3+
- Add and save an itinerary to an itineraries binary file that can be loaded and updated.
4+
- Edit a saved itinerary item (e.g., name, location, flight departure date & time).
5+
- Add multiple flights and/or attractions to one of the existing itineraries.
6+
- View your itineraries (or a specific itinerary) in a formatted table.
7+
- Delete a full itinerary, or just a flight or attraction from a specific itinerary (note: can only delete flights/attractions if there are more than 1 associated with that itinerary).
88

99
# Prerequisites
1010
- Python 3.14
1111
- pip (Python package installer)
12-
- Git Bash
13-
- (List out the libraries imported in the script)
12+
- Command Line/Terminal (to run the application)
13+
- rich 14.2.0
14+
- pick 2.4.0
1415

1516
# Installing instructions
1617
1. Clone the repository to your local machine
@@ -19,19 +20,35 @@ Short description of package/script
1920
```
2021
2. Change directory into the cloned repository
2122
```bash
22-
cd All-In-One-Python-Projects/'Travel Itinerary Planner'/
23+
cd All-In-One-Python-Projects/'Travel_Itinerary_Planner'/
2324
```
2425
3. Install the required libraries
2526
```bash
2627
pip install -r requirements.txt
2728
```
28-
4. Run the program using
29+
4. Run the program in Command Line or Terminal using
2930
```bash
3031
python3 main.py
3132
```
3233

3334
# Screenshot
34-
- Display images/gifs/videos of output/result of your script so that users can visualize it.
35+
### Welcome to the Travel Itinerary Planner!
36+
![Welcome to the Travel Itinerary Planner!](assets/welcome-to-the-app.png)
37+
38+
### Choose what items to edit
39+
![Choose itinerary to edit](assets/choose-itinerary-to-edit.png)
40+
![Choose itinerary key to edit](assets/choose-item-key-to-edit.png)
41+
42+
### View your itineraries, formatted into a neat table!
43+
![View itineraries in a table format](assets/view-itineraries.png)
44+
45+
### And other neat features listed at the top of this document :)
3546

3647
# Author
3748
Gabrielle Allan
49+
50+
# Library credits
51+
52+
[pick library](https://pypi.org/project/pick/)
53+
54+
[rich library](https://github.com/Textualize/rich)
5.42 KB
Loading
4.5 KB
Loading
52.3 KB
Loading
29.9 KB
Loading

0 commit comments

Comments
 (0)