Skip to content

Commit 09fde74

Browse files
committed
updated README
1 parent 190e13b commit 09fde74

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
---
66

7-
### **_Purpose_**
8-
This program is designed to create and manage a database of clients<br>
9-
and generate unique pictures (_tickets_) corresponding to each client.<br>
10-
This software can be used for both **commercial** and **non-commercial** purposes.<br>
7+
### **Overview**
8+
> This program is designed to create and manage a database of clients<br>
9+
> and generate unique pictures (<font color='ee82ee'>_tickets_</font>) corresponding to each client.<br>
10+
> This software can be used for both **commercial** and **non-commercial** purposes.<br>
1111
12-
### **_Functionalities_**
12+
### **Functionalities**
1313
* Generation of pictures (_tickets_)
1414
* Database creation of any size
1515
* Database editing similar to Excel
@@ -18,27 +18,27 @@ This software can be used for both **commercial** and **non-commercial** purpose
1818
* Copying pictures to clipboard
1919
* Customization of _fonts_ and text _colors_
2020

21-
### **_How to Build_**
22-
1. Download & Install **[Qt5][4]**
23-
24-
#### **Configuring**
25-
To configure the project, add the following flags:
26-
```
27-
"-DCMAKE_PREFIX_PATH=path/to/Qt5"
21+
### **How to Build**
22+
1. Install Cmake
23+
2. Download & Install **[Qt5][4]**
24+
3. ```sh
25+
cmake -DCMAKE_BUILD_TYPE={type} -DCMAKE_PREFIX_PATH=path/to/Qt5 -G {generator} -B ./cmake-build-{type}
26+
cmake --build ./cmake-build-debug --target TIP -j 14
2827
```
2928

3029
#### **Deployment**
3130
1. Install **[Inno Setup][5]**
3231
2. Install **[Inno Download Plugin][6]**
3332
3. To activate deployment mode, add the following flag to the CMake configuration:
34-
```
35-
"-DDEPLOY_DEPENDENCY=\"path/to/idp.iss\""
33+
```sh
34+
cmake -DCMAKE_BUILD_TYPE={type} -DCMAKE_PREFIX_PATH=path/to/Qt5 "-DDEPLOY_DEPENDENCY=\"path/to/idp.iss\"" -G {generator} -B ./cmake-build-{type}
35+
cmake --build ./cmake-build-debug --target TIP -j 14
3636
```
3737
or run [windows_deploy.bat][8] after building the project and enter `"path/to/idp.iss"` as an argument.
3838

3939
#### **Database**
40-
To enable the program to function, you need to deploy a PostgreSQL database.<br>
41-
Requests for creating the necessary structure are located in the [database][7] folder.
40+
> To enable the program to function, you need to deploy a PostgreSQL database.<br>
41+
> Requests for creating the necessary structure are located in the [database][7] folder.
4242
4343
---
4444

0 commit comments

Comments
 (0)