Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kazuyanagimoto committed Apr 25, 2024
1 parent 5a73aa7 commit dad77a5
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 5 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

# typstcv

<!-- badges: start -->

<a href="https://kazuyanagimoto.r-universe.dev"><img src="https://kazuyanagimoto.r-universe.dev/badges/typstcv" class="img-fluid" alt="R-universe status badge"></a>
[![R-CMD-check](https://github.com/kazuyanagimoto/typstcv/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/kazuyanagimoto/typstcv/actions/workflows/R-CMD-check.yaml)
<a href = "https://github.com/kazuyanagimoto/typstcv/blob/main/LICENSE.md" target = "_blank"><img src="https://img.shields.io/badge/license-MIT-blue"></a>
[![Docs](https://img.shields.io/badge/docs-homepage-blue.svg)](https://kazuyanagimoto.com/typstcv/index.html)
<!-- badges: end -->

![](vignettes/typstcv.svg)

This package provides helper functinons for
Expand All @@ -19,19 +27,27 @@ This work are inspired by these three works:

## Installation

You can install the development version of quartomonothemer from
R-universe with:
You can install the development version of typstcv from R-universe with:

``` r
install.packages("typstcv", repos = "https://kazuyanagimoto.r-universe.dev")
```

## Usage

You can find a simple [example](vignettes/typstcv.pdf) and
You can find a simple
[example](https://kazuyanagimoto.com/typstcv/vignettes/typstcv.pdf) and
[qmd](https://github.com/kazuyanagimoto/typstcv/blob/main/vignettes/typstcv.qmd)
code.

### Use Template

You can use the template with `quarto` command.

``` bash
quarto use template kazuyanagimoto/quarto-awesomecv-typst
```

### YAML

Set author information in YAML.
Expand Down
14 changes: 12 additions & 2 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This package provides helper functinons for [kazuyanagimoto/quarto-awesomecv-typ
This work are inspired by these three works:

- Byungjin Park's [Awesome-CV](https://github.com/posquit0/Awesome-CV)
- A beautiful $\LaTeX$ template of CV
- A beautiful LaTeX template of CV
- Paul Tsouchlos's [modern-cv](https://typst.app/universe/package/modern-cv/)
- A [Typst](https://typst.app) implementation of Awesome-CV
- Mitchell O'Hara-Wild and Rob Hyndman's [vitae](https://pkg.mitchelloharawild.com/vitae/)
Expand All @@ -38,7 +38,17 @@ install.packages("typstcv", repos = "https://kazuyanagimoto.r-universe.dev")

## Usage

You can find a simple [example](vignettes/typstcv.pdf) and [qmd](https://github.com/kazuyanagimoto/typstcv/blob/main/vignettes/typstcv.qmd) code.
You can find a simple [example](https://kazuyanagimoto.com/typstcv/vignettes/typstcv.pdf) and
[qmd](https://github.com/kazuyanagimoto/typstcv/blob/main/vignettes/typstcv.qmd)
code.

### Use Template

You can use the template with `quarto` command.

```bash
quarto use template kazuyanagimoto/quarto-awesomecv-typst
```

### YAML

Expand Down

0 comments on commit dad77a5

Please sign in to comment.