From 0918da035bcbd430639b81e902be3176c24dffab Mon Sep 17 00:00:00 2001 From: Jitin Nair Date: Tue, 4 Jun 2024 14:43:13 +0530 Subject: [PATCH] updated quickstart instructions for clarity --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 472f673..f13bdac 100644 --- a/README.md +++ b/README.md @@ -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)