Skip to content

Commit 0370502

Browse files
authored
format changes and added credits
1 parent 893c8bf commit 0370502

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
Requirements
22
============
33

4-
* Latex (depends on template used), Install using
4+
* Latex (depends on template used), Install using:
5+
56
```console
67
$ sudo apt install texlive-full
78
```
9+
810
* Python 3.6
911

1012
Python packages:
@@ -15,9 +17,10 @@ Python packages:
1517
* PyQt5==5.12.2
1618
* PyQt5-sip==4.19.17
1719

18-
run in your shell:
20+
run in your shell:
21+
1922
```console
20-
pip install -r requirements.txt
23+
$ pip install -r requirements.txt
2124
```
2225

2326
Usage
@@ -51,7 +54,7 @@ Add content to About me, why this firm? and why you? tab as you require. Keep it
5154
![Aboutme Tab](docs/images/aboutme_tab.png "About me Tab")
5255

5356

54-
Finally in Finish tab add closing salutation and then select attached documents. Then click on `Generate PDF` or `Generate Text` button.
57+
Finally in Finish tab add closing salutation and then select attached documents. Then click on <kbd>Generate PDF</kbd> or <kbd>Generate Text</kbd> button.
5558

5659
![Finish Tab](docs/images/finish_tab.png "Finish me Tab")
5760

@@ -97,6 +100,8 @@ Variable names that can be used in templates can be easily copied by clicking on
97100

98101
Variables can be used as the jinja documentation defines. Along with any control statements.
99102

103+
***
104+
100105
Example of Variable usage:
101106

102107
Latex:
@@ -110,6 +115,7 @@ Text:
110115
```python
111116
{{FIRSTNAME}}
112117
```
118+
***
113119

114120
Example of control statements:
115121

@@ -134,5 +140,12 @@ Sir / Madam
134140
{% endif -%}
135141
,
136142
```
143+
***
144+
145+
See example templates [Latex Template](Latex/Templates/Awesome-CV/Latex_template.tex) and [Text Template](Text/Templates/Simple/Text_template.txt) for more indept usage.
146+
147+
Credits
148+
=======
137149

138-
See example templates [Latex Template](Latex/Templates/Awesome-CV/Latex_template.tex) and [Text Template](Text/Templates/Simple/Text_template.txt)
150+
* Latex template used: [posquit0's Awesome-CV](https://github.com/posquit0/Awesome-CV)
151+
* Spell check modified from this [blog](https://nachtimwald.com/2009/08/22/qplaintextedit-with-in-line-spell-check/)

0 commit comments

Comments
 (0)