Updated readme.md

Author: orensbruli

README.md

@@ -1,91 +1,70 @@
 # ten-seconds-cv
-> A LaTeX resume/cv template for DevOps Engineer to make quick update and
-> pdf creation
 
-This template I use for my own resume/CV.
+Hi!
+My name is Esteban Martinena, a Software Engineer from Spain. 
+This is my resume, built with LaTeX, Pandoc, Docker...
 
-```shell
-docker build -t latex-cv .
-docker run -v $(pwd):/latex_content latex-cv /bin/bash -c "make pdf"
-#docker run -v $(pwd):/latex_content --name latex-container latex-cv /bin/sh -c "make pdf"
-#docker cp latex-container:/latex_content/cv-piotr-kowalski.pdf output.pdf
-#docker remove /latex-container
-```
+## Why?
+As many other developers, I really hate to write or update my resume.
+I've tried many different approaches, but I've never been satisfied with the result.
+Including new information, changing the format, or even modifying the order of the sections was always a pain.
 
+At some point, I decided to write my resume in LaTeX,
+but the more important thing was to automate the process of building the PDF file
+and extracting the information from a single source of truth.
 
+Also, I wanted to have a repository with my resume, so I could track the changes and share it with others, and
+at the same time show some of my skills as DevOps and Software Engineer here.
 
-## Install pre-requisites (Windows)
+So, not only the PDF generated in this repository is my resume, but also the repository itself.
 
-1. Install [MiKTeX](https://miktex.org/howto/install-miktex), a TeX
-   distribution for Windows that includes a large number of major packages.
+As you can see in the commit history, it's a work in progress that started recently.
+So don't be too harsh with me :) It's NOT yet on version 1.0.
 
-2. Install an editor to edit and compile LaTeX documents:
-  - [TexWorks](http://www.tug.org/texworks/) (comes with MiKTeX)
-  - [TeXstudio](http://www.texstudio.org/)
-  - [Texmaker](http://www.xm1math.net/texmaker/)
+## How?
+Apart from using some nice LaTeX templates,
+I've used [Pandoc](https://pandoc.org/) to convert the Markdown file to LaTeX.
+This way I can write my resume in the data.md file, and then generate the LaTeX file and the PDF when I change it.
 
-Once both the distribution and editor are installed, clone this repository
-using `git clone` and open the template.tex file in your editor.
+I've also used [Docker](https://www.docker.com/) to build the PDF file,
+so I (or anyone else) can build it without installing anything else.
 
-**Important**: Make sure to compile with XeLaTeX, not PDFLaTeX.
-You're good to go!
+At some point, I also decided I wanted a more visual to show my skills.
+Having the GitHub heatmap in mind, I decided to create a heatmap of my skills.
+I have created a simple Python script that generates eps file with the heatmap, and then I include it in the LaTeX file.
 
-## Install pre-requisites (Debian/Ubuntu)
-* texlive: `sudo apt-get install texlive`
-* texlive-xetex: `sudo apt-get install texlive-xetex`
-* texlive-lualatex: `sudo apt-get install texlive-luatex`
-* texlive-math-extra: `sudo apt-get install texlive-math-extra`
-* texlive-fonts-extra: `sudo apt-get install texlive-fonts-extra`
-* texlive-pstricks: `sudo apt-get install texlive-pstricks`
-* texmaker: `sudo apt-get install texmaker`
+## GitHub actions
+I have created some GitHub actions to automate the process of building the PDF file.
 
-## Build (Windows)
+### Docker image build
+To avoid building the docker image every time, I've created a GitHub action that builds the image and pushes it to GHCR.
+It's only triggered when the Dockerfile or requirements.txt changes.
 
-Open `.tex` file with `TexMaker` or `TexWorks` and compile using XeLaTeX
+### PDF build
+This is the main action.
+It is run on every push, and it uses the docker image built in the previous step to build the PDF file.
+After building the PDF file, it's uploaded as an artifact, so it can be downloaded from the Actions tab.
 
-## Build (Debian/Ubuntu)
+On release, the PDF file is also uploaded as a release asset.
 
-	make all
+## How to build the PDF file locally?
 
-## FontAwesom support
+Clone this repository and run the following command in the root directory of the repository:
+```shell
+docker build -t latex-cv .
+docker run -v $(pwd):/latex_content --name latex-container latex-cv /bin/sh -c "make pdf"
+docker cp latex-container:/latex_content/cv-piotr-kowalski.pdf output.pdf
+docker remove /latex-container
 
-To enable fontawesome support, include the fontawesome package in the `.tex` file
+# If you don't need to copy the PDF file from the container, you can use this command instead
+docker run -v $(pwd):/latex_content latex-cv /bin/bash -c "make pdf"
+```
 
-	\usepackage{fontawesome}
 
-and compile the document using LuaLaTex
 
 ## References
 
-The elements comes from several templates, including:
-
-1. [Font Awesome Icons](https://faicons.com/)
+The initial idea for this repo came from the following repositories:
+1. [Ten Seconds CV](https://github.com/bitroniq/ten-seconds-cv)
 2. [Carmine Spagnuolo's Twenty Seconds Curriculum Vitae](https://github.com/spagnuolocarmine/TwentySecondsCurriculumVitae-LaTex)
-3. [Carmine Benedetto's Smart Fancy LaTeX CV](https://github.com/neoben/smart-fancy-latex-cv)
-4. [Adrien Friggeri's Fancy CV](https://www.sharelatex.com/templates/52fb8c1f33621a613683ecad)
-5. [Harsh Gadgil opensorcer/Data-Engineer-Resume-LaTeX](https://github.com/opensorceror/Data-Engineer-Resume-LaTeX)
-
-
-## License
-
-> MIT License
-
-> Copyright (c) 2019 Esteban Martinena
-
-> Permission is hereby granted, free of charge, to any person obtaining a copy
-> of this software and associated documentation files (the "Software"), to deal
-> in the Software without restriction, including without limitation the rights
-> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-> copies of the Software, and to permit persons to whom the Software is
-> furnished to do so, subject to the following conditions:
-
-> The above copyright notice and this permission notice shall be included in all
-> copies or substantial portions of the Software.
-
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-> SOFTWARE.
+3. [Harsh Gadgil opensorcer/Data-Engineer-Resume-LaTeX](https://github.com/opensorceror/Data-Engineer-Resume-LaTeX)