diff --git a/README.md b/README.md index e4b7421..2916279 100644 --- a/README.md +++ b/README.md @@ -16,70 +16,70 @@ -## _certificate-generator?_ +## Introduction -- _Many bulk certificate generators use jpeg or other image formats to create certificates which often results in poor quality of the certificates._ -- _This project aims to produce certificates that are lossless and are of high quality by using PDF format._ -- _`certificate-generator.py` is a simple python script that can produce multiple certificates from a given template (in PDF)._ -- _The name of the participants are provided by the user in the form of a spreadsheet._ -- _The font style, size and position of the text to be printed on the certificate is also provided by the user._ +- Many bulk certificate generators use jpeg or other image formats to create certificates which often results in poor quality of the certificates. +- This project aims to produce certificates that are lossless and are of high quality by using PDF format. +- `certificate-generator.py` is a simple python script that can produce multiple certificates from a given template (in PDF). +- The name of the participants are provided by the user in the form of a spreadsheet. +- The font style, size and position of the text to be printed on the certificate is also provided by the user. -## _Getting Started_ +## Getting Started -_The following instructions would help you run the python script on your local machine._ +The following instructions would help you run the python script on your local machine. -### _Prerequisites_ +### Prerequisites -- _**Python 3.2 or higher**_ +- **Python 3.2 or higher** -_Python modules to be installed:_ -- _PyPDF2_ -- _pandas_ -- _reportlab_ +Python modules to be installed: +- PyPDF2 +- pandas +- reportlab -### _Installation_ +### Installation -- _Install the required python modules: `pip3 install PyPDF2 pandas reportlab`_ -- _Clone this repository: `git clone https://github.com/sanbabyfrancis/certificate-generator.git`_ +- Install the required python modules: `pip3 install PyPDF2 pandas reportlab` +- Clone this repository: `git clone https://github.com/sanbabyfrancis/certificate-generator.git` -## _Usage_ +## Usage -- _Move into the directory containing the python script: `cd certificate-generator`_ -- _Copy the template of the certificate (in .pdf format) into the directory._ -- _Copy the spreadsheet that contains the name of the participants into the directory._ -- _Copy a font file (in .ttf format) into the directory. The name will be printed using this font._ -- _Run the python script: `python3 certificate-generator.py`_ -- _Provide the necessary inputs to the program. Pixel dimension specifies the position where the name has to be printed on the certificate._ -- _The certificates will be generated inside the `certificates` directory._ +- Move into the directory containing the python script: `cd certificate-generator` +- Copy the template of the certificate (in .pdf format) into the directory. +- Copy the spreadsheet that contains the name of the participants into the directory. +- Copy a font file (in .ttf format) into the directory. The name will be printed using this font. +- Run the python script: `python3 certificate-generator.py` +- Provide the necessary inputs to the program. Pixel dimension specifies the position where the name has to be printed on the certificate. +- The certificates will be generated inside the `certificates` directory. -## _Screenshots_ +## Screenshots sanbabyfrancis@Lenovo___certificate generator -_template.pdf_ | _example.pdf_ +template.pdf | example.pdf --- | --- ![template](https://user-images.githubusercontent.com/73488722/158216104-5a3a1650-82a4-466b-8620-d561865413d9.png) | ![DONELL BASSETT](https://user-images.githubusercontent.com/73488722/158215512-1baa208e-003c-4395-a004-61a3cee865c1.png) -## _Contact_ +## Contact [![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/sanbabyfrancis.svg?style=social&label=Follow%20%40sanbabyfrancis)](https://twitter.com/sanbabyfrancis) -**_San Baby Francis_**
-_san.baby.francis123@gmail.com_ +**San Baby Francis**
+san.baby.francis123@gmail.com -## _Acknowledgments_ +## Acknowledgments -* _[Add text to existing pdf using python](https://stackoverflow.com/questions/1180115/add-text-to-existing-pdf-using-python)_ -* _[mursalfk/Certificate-Generator](https://github.com/mursalfk/Certificate-Generator)_ -* _[bhargav-joshi/Bulk-Certificates-Generator](https://github.com/bhargav-joshi/Bulk-Certificates-Generator)_ +* [Add text to existing pdf using python](https://stackoverflow.com/questions/1180115/add-text-to-existing-pdf-using-python) +* [mursalfk/Certificate-Generator](https://github.com/mursalfk/Certificate-Generator) +* [bhargav-joshi/Bulk-Certificates-Generator](https://github.com/bhargav-joshi/Bulk-Certificates-Generator)