From 7f12a64f007b695a0092461888095be797136c7e Mon Sep 17 00:00:00 2001 From: Tigor Hutasuhut Date: Tue, 25 Jun 2024 13:02:20 +0700 Subject: [PATCH] update readme --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cbf125d..053db7e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Curriculum Vitae -Resume written in Typst, a Rust based Latex alternative. +Resume written in [Typst], a Rust based Latex alternative. For the actual content of the resume, see [resume.typ](./resume.typ). @@ -10,12 +10,20 @@ For the actual content of the resume, see [resume.typ](./resume.typ). Use `direnv allow` to load the nix environment. It will install the necessary tooling to edit and build the resume. +You will need to have [nix-direnv] installed and configured. + ### Others -To build the resume, you need to have [`typst`](https://github.com/typst/typst) binary installed and available in your PATH. +To build the resume, you need to have [typst] binary installed and available in your PATH. -## CI/CD +## CI/CD (Automatic PDF Build) -Every push of this repository will trigger a Forgejo Action that will build the PDF file and upload it to the artifacts. PDF can be downloaded from the artifacts tab. +Every push of this repository will trigger a [Forgejo Action] that will build the PDF file and upload it to the artifacts. PDF can be downloaded from the artifacts tab. -Go to the [Actions](https://git.tigor.web.id/tigor/Curriculum-Vitae/actions), click on the latest successful build, and check the Artifacts section in the left sidebar. +Go to the [Actions], click on the latest successful build, and check the Artifacts section in the left sidebar. + +[Actions]: https://git.tigor.web.id/tigor/Curriculum-Vitae/actions +[Forgejo Action]: https://git.tigor.web.id/tigor/Curriculum-Vitae/actions +[typst]: https://github.com/typst/typst +[Typst]: https://github.com/typst/typst +[nix-direnv]: https://github.com/nix-community/nix-direnv