Skip to content

Commit f8aca8e

Browse files
committed
update readme
1 parent 9810dbd commit f8aca8e

File tree

6 files changed

+39
-4
lines changed

6 files changed

+39
-4
lines changed

README.md

+38-3
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,43 @@ Terminal based quiz application with category based quizzing and SQL Database co
99
- Database connectivity to save and view high scores using MariaDb
1010
- modularised codebase using header and implementation files
1111

12+
## Screenshots
13+
14+
![screenshot1](ss1.jpg)
15+
<br/>
16+
![screenshot2](ss2.jpg)
17+
![screenshot3](ss3.jpg)
18+
1219
## Libraries used
1320

14-
- json
15-
- mariadb connector
16-
- POCO
21+
- [nlohmann/json](https://github.com/nlohmann/json)
22+
- [mariadb connector](https://github.com/mariadb-corporation/mariadb-connector-cpp)
23+
- [poco](https://github.com/pocoproject/poco)
24+
25+
## Usage
26+
27+
- Install and Start mariaDb
28+
29+
```bash
30+
sudo systemctl start mariadb
31+
```
32+
33+
- clone this repository
34+
- install the libraries based on your package manager
35+
- connect using the db username and password. [Ref](https://mariadb.com/docs/connect/programming-languages/cpp/connect/)
36+
- navigate to project root
37+
- compile and link cpp files using g++
38+
39+
```bash
40+
g++ main.cpp implemetations/*.cpp -lPocoNetSSL -lPocoFoundation -lPocoNet -lPocoUtil -lmariadbcpp
41+
```
42+
43+
- Ensure that you have internet connectivity
44+
45+
- start program
46+
47+
```bash
48+
./a.out
49+
```
50+
51+
### Note: these commands are tested just in Arch Linux for now. There may be slight modifications needed for the commands specific to your OS.

a.out

761 KB
Binary file not shown.

main.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ using std::string;
1616
int main() {
1717
string playerName;
1818
cout << "Enter your name: ";
19-
cin >> playerName;
19+
getline(cin, playerName);
2020
cout << "Hello " << playerName << ", Welcome to cQuiz!\n\n";
2121
cout << "Loading categories available...\n";
2222

ss1.jpg

54.6 KB
Loading

ss2.jpg

55.8 KB
Loading

ss3.jpg

48.3 KB
Loading

0 commit comments

Comments
 (0)