Skip to content

Commit

Permalink
updated quickstart instructions for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
jitinnair1 committed Jun 4, 2024
1 parent 2c71e7f commit 0918da0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ The template is designed to be clean with sections for

## Quickstart
- Fork this repo (you can use the `Use this template` button)
- Give the workflow write permissions for your forked repo (Settings -> Actions -> General)
- Modify the `cv.tex` file and push changes to your repo
- Set GitHub pages source to build branch (Settings -> Pages)
- The complied PDF will be available under the `build` branch

You can get a direct link to the generated PDF which you can use on your website, LinkedIn etc. that will always point to the latest version of your CV. Once your site is published, your CV will be accessible at: `https://username.github.io/repo-name/`

For this, after editing your copy of `cv.tex` and pushing changes to your repo, under Settings -> Pages set your Github Pages source to the `build` directory
NOTE: For the direct link to work, after editing your copy of `cv.tex` and pushing changes to your repo, under Settings -> Pages set your Github Pages source to the `build` directory

![](https://i.imgur.com/lwATw1o.png)

Expand Down

0 comments on commit 0918da0

Please # to comment.