Skip to content

Commit

Permalink
Update readme with instructions on fonts
Browse files Browse the repository at this point in the history
  • Loading branch information
rezbyte committed Oct 15, 2022
1 parent 6295d28 commit b46f674
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This my attempt at porting [kaityo256's yaml_cv](https://github.com/kaityo256/ya
It supports all the style files the original does.
I wrote this to practice writing in Rust, so I don't intend to maintain this.

It's easier to setup, available as a [single download](https://github.com/rezbyte/yaml_cv_rs/releases).
It's easier to setup, available as a [download](https://github.com/rezbyte/yaml_cv_rs/releases).
Runs around twice as fast than the original Ruby script.

![screenshot1](sample/academic1.jpg)
Expand Down Expand Up @@ -40,6 +40,10 @@ After that, `yaml_cv_rs` should be ready for use in `target/release`.

## Usage <a name = "usage"></a>

First [download the IPA mincho & gothic fonts](https://moji.or.jp/ipafont/ipaex00401/).
Extract the IPA fonts into `yaml_cv_rs/fonts`.

You can run the program directly with `./yaml_cv_rs`.
The usage is identical to kaityo256's version.

You can run `yaml_cv_rs --help` to get usage instructions:
Expand Down

0 comments on commit b46f674

Please sign in to comment.