README.md

yaml_cv_rs

Table of Contents

• About
• Getting Started
• Usage

About

This is my attempt at porting kaityo256's yaml_cv to Rust. 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 download. Runs around twice as fast than the original Ruby script.

Getting Started

These instructions will build a copy of the project up and running on your local machine.

Prerequisites

You will need Rust installed.

Installing

First, build the project in cargo:

cargo ship

Then copy the:

• IPA fonts into target/release/fonts.
• Standard or academic style files into target/release.
• Data YAML file into target/release.

After that, yaml_cv_rs should be ready for use in target/release.

Usage

First download the IPA mincho & gothic fonts. 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:

Usage: yaml_cv_rs [OPTIONS]

Options:
  -i, --input <INPUT>    Path to the input file in YAML format [default: data.yaml]
  -s, --style <STYLE>    Path to the styling file [default: style.txt]
  -o, --output <OUTPUT>  Path to output the final PDF file to [default: output.pdf]
  -h, --help             Print help information
  -V, --version          Print version information