Skip to content

Commit dffc49d

Browse files
author
Jimmy Chu
authored
chore(README): update README (#32)
1 parent ec69116 commit dffc49d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,15 @@ This is a GitHub template repository, feel free to use it and adapt it to your u
1212
# How to use
1313
## Requirements
1414
- Docker
15+
- Optional: GitHub Settings App: https://probot.github.io/apps/settings/
16+
- Optional: GitHub Stale App: https://github.com/apps/stale
1517

1618
## Getting started
1719
- Use this template to create your own repository: https://github.com/chujimmy/cv_template/generate
1820
- Checkout your newly created repository
1921
- Update environment variables in the `docker-compose.yml` file accordingly
2022
- Fill the CVs with your experiences
23+
- Update notification settings (if needed)
2124

2225
## Run the container
2326
`make start` will download and build the Docker image and then start the container. It will automatically find all `cv.tex` and `letter.tex` files located in the correct folders (respectively `./src/cv/lang/<lang>/cv.tex` and `./src/letter/lang/<lang>/letter.tex`), compile them to generate the pdf files and watch them, so they will be automatically recompiled on update.

0 commit comments

Comments
 (0)