Skip to content

Commit b859b8a

Browse files
authored
Update README.md
1 parent 6436068 commit b859b8a

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,33 @@
1-
# Restaurant-Ratings-Part-2
1+
![video_poster_1](https://github.com/Python-Coding-Assignments/Restaurant-Ratings-Part-1/assets/154717520/f187d60f-69a1-456e-a825-24bcd4ab554b)
2+
3+
<details>
4+
<summary>Table of Contents</summary>
5+
<ol>
6+
<li>
7+
<a href='#about-the-project'>About the Project</a>
8+
</li>
9+
<li>
10+
<a href='#getting-started'>Getting Started</a>
11+
</li>
12+
<li>
13+
<a href='#Contact'>Contact</a>
14+
</li>
15+
</ol>
16+
</details>
17+
18+
## About the Project
19+
This project simulates a simple application where information about a restaurant is made available to the user. The user can do any of the following: print all restaurants (including information about each restaurant), print all ratings for a restaurant specified by the user, add more ratings to a restaurant he or she specifies, and lastly print a specified restaurant's rating.
20+
21+
The objective of this program is to demonstrate the following:
22+
* show a basic understanding of classes and how they work, including the init constructor, setters, and getters
23+
* utilize packages to organize classes and functions in different directories
24+
* display an understanding of mutable and immutable variables and how/if they are modified by a function
25+
26+
In this program, the user can enter anything, even when prompted with entering an integer menu selection, and the program will still function as intended.
27+
28+
## Getting Started
29+
To run the program, download the contents of the project and simply run make in the terminal.
30+
31+
## Contact
32+
Name: Garrett Ellis\
33+
Project Link: [https://github.com/Python-Coding-Assignments/Restaurant-Ratings-Part-2]()

0 commit comments

Comments
 (0)