docs: add README with example renderings and license info
This commit is contained in:
parent
fc70bc28ab
commit
ae00071ecf
3 changed files with 49 additions and 0 deletions
49
README.md
49
README.md
|
|
@ -0,0 +1,49 @@
|
|||
# CV Generator
|
||||
|
||||
Generate a polished PDF CV from a Markdown file with YAML frontmatter.
|
||||
|
||||
The CV data (work experience, education, skills, etc.) is defined as structured YAML frontmatter, while the cover letter is written as regular Markdown below it. The tool renders everything into a styled PDF using Jinja2 templates and WeasyPrint.
|
||||
|
||||
## Example
|
||||
|
||||
The `example/` directory contains a sample CV for Albert Einstein, applying to the Swiss Patent Office in 1902.
|
||||
|
||||
| Cover Letter | CV |
|
||||
|---|---|
|
||||
|  |  |
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
uv run cv path/to/your_cv.md
|
||||
```
|
||||
|
||||
To specify a custom output path:
|
||||
|
||||
```bash
|
||||
uv run cv path/to/your_cv.md -o output.pdf
|
||||
```
|
||||
|
||||
## Markdown File Format
|
||||
|
||||
The input file uses YAML frontmatter for structured data and Markdown for the cover letter body. See `example/alberteinstein.md` for a complete example.
|
||||
|
||||
Photo and signature paths are resolved relative to the Markdown file's location.
|
||||
|
||||
## Third-Party Assets
|
||||
|
||||
The following bundled assets are licensed separately from this project:
|
||||
|
||||
- **Fira Sans Condensed** (`src/cv_generator/fonts/`)
|
||||
Designed by Carrois Corporate GbR & Edenspiekermann AG for the Mozilla Foundation.
|
||||
Licensed under the [SIL Open Font License, Version 1.1](https://scripts.sil.org/OFL).
|
||||
Source: [github.com/mozilla/Fira](https://github.com/mozilla/Fira)
|
||||
|
||||
- **Bootstrap Icons** (`src/cv_generator/icons/`)
|
||||
Copyright 2019-2024 The Bootstrap Authors.
|
||||
Licensed under the [MIT License](https://github.com/twbs/icons/blob/main/LICENSE).
|
||||
Source: [icons.getbootstrap.com](https://icons.getbootstrap.com/)
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the [MIT License](LICENSE.md).
|
||||
BIN
example/einstein_cv-1.png
Normal file
BIN
example/einstein_cv-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 344 KiB |
BIN
example/einstein_cv-2.png
Normal file
BIN
example/einstein_cv-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 582 KiB |
Loading…
Add table
Add a link
Reference in a new issue