Skip to content

Commit

Permalink
refactor!: rename function and variable names to kebab case (#50)
Browse files Browse the repository at this point in the history
* refactor variables and function originating on cv.typ

* rename missing from cv.typ

* refactor letter.typ

* refactor lib.typ

* utils refactor

* template refactor
  • Loading branch information
ericthomasca authored Aug 17, 2024
1 parent af020f5 commit f571c3f
Show file tree
Hide file tree
Showing 30 changed files with 366 additions and 366 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ With an existing CV project using the `v1` version of the template, a migration
3. For `cv.typ` and `letter.typ`, copy the new files from the repo, and adapt the modules you have in your project.
4. For the module files in `/modules_*` folders:
1. Delete the old import `#import "../brilliant-CV/template.typ": *`, and replace it by the import statements in the new template files.
2. Due to the Typst path handling mecanism, one cannot directly pass the path string to some functions anymore. This concerns, for example, the `logo` argument in `cvEntry`, but also on `cvPublication` as well. Some parameter names were changed, but most importantly, **you should pass a function instead of a string (i.e. `image("logo.png")` instead of `"logo.png"`).** Refer to new template files for reference.
2. Due to the Typst path handling mecanism, one cannot directly pass the path string to some functions anymore. This concerns, for example, the `logo` argument in `cv-entry`, but also on `cv-publication` as well. Some parameter names were changed, but most importantly, **you should pass a function instead of a string (i.e. `image("logo.png")` instead of `"logo.png"`).** Refer to new template files for reference.
5. You might need to install `Roboto` and `Source Sans Pro` on your local system now, as new Typst package discourages including these large files.
6. Run `typst c cv.typ` without passing the `font-path` flag. All should be good now, congrats!

Expand Down
Loading

0 comments on commit f571c3f

Please sign in to comment.