this repo has no description
repo: update readme
+10
-70
+10
-70
README.md
+10
-70
README.md
···
1
-
# Vantage Typst
2
-
3
-
An ATS friendly simple Typst CV template, inspired by [alta-typst by George Honeywood](https://github.com/GeorgeHoneywood/alta-typst). See [`example.pdf`](example.pdf) for the rendered PDF output.
4
-
5
-
6
-
7
-
## Features
8
-
9
-
- **Two-column layout**: Experience on the left and other important details on the right, organized for easy scanning.
10
-
- **Customizable icons**: Add and replace icons to suit your personal style.
11
-
- **Responsive design**: Adjusts well for various print formats.
12
-
13
-
## Usage
14
-
15
-
### Running Locally with Typst CLI
16
-
17
-
1. **Install Typst CLI**: Follow the installation instructions on the [Typst CLI GitHub page](https://github.com/typst/typst#installation) to set up Typst on your machine.
18
-
19
-
2. **Clone the repository**:
20
-
21
-
```bash
22
-
git clone https://github.com/sardorml/vantage-typst.git
23
-
cd vantage-typst
24
-
```
25
-
26
-
3. **Run Typst**:
27
-
28
-
Use the following command to render your CV:
29
-
30
-
```bash
31
-
typst compile example.typ
32
-
```
33
-
34
-
This will generate a PDF output in the same directory.
35
-
36
-
4. **Edit your CV**:
37
-
38
-
Open the `example.typ` file in your preferred text editor to customize the layout.
39
-
40
-
### Configuration
41
-
42
-
You can easily customize your personal data by editing the `configuration.yaml` file. This file allows you to set your name, contact information, work experience, education, and skills. Here’s how to do it:
43
-
44
-
1. Open the `configuration.yaml` file in your text editor.
45
-
2. Update the fields with your personal information.
46
-
3. Save the file, and your CV will automatically reflect these changes when you compile it.
47
-
48
-
## Icons
49
-
50
-
You can enhance your CV with additional icons by following these steps:
51
-
52
-
1. **Upload Icons**: Place your `.svg` files in the `icons/` folder.
53
-
54
-
2. **Reference Icons**: Modify the `links` array in the Typst file to include your new icons by referencing their filenames as the `name` values.
55
-
56
-
Example:
57
-
58
-
```typst
59
-
links: [
60
-
{ name: "your-icon-name", url: "https://example.com" },
61
-
]
62
-
```
1
+
# CV
63
2
64
-
For existing icons, the current selection is sourced from [Lucide Icons](https://lucide.dev/icons/).
3
+
My personal CV built with Typst.
65
4
66
-
## License
5
+
## Build
67
6
68
-
This project is licensed under the [MIT License](./LICENSE).
7
+
```bash
8
+
typst compile cv_tymek_chmielecki.typ && open cv_tymek_chmielecki.pdf
9
+
```
69
10
70
-
Icons are from Lucide Icons and are subject to [their terms](https://lucide.dev/license).
11
+
## Configuration
71
12
72
-
## Acknowledgments
13
+
Edit `configuration.yaml` to update personal info, experience, projects, etc.
73
14
74
-
- Inspired by the work of [George Honeywood](https://github.com/GeorgeHoneywood/alta-typst).
75
-
- Thanks to [Lucide Icons](https://lucide.dev/icons/) for providing the icon library.
15
+
## Template
76
16
77
-
For any questions or contributions, feel free to open an issue or submit a pull request!
17
+
Based on [vantage-typst](https://github.com/sardorml/vantage-typst).