From 40e23ef549bf83c38a297d29ccddc11a31d46334 Mon Sep 17 00:00:00 2001 From: Aaron LI Date: Fri, 3 Feb 2023 09:06:11 +0800 Subject: README: Briefly describe the usage on Windows with MiKTeX --- README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 648cf08..8dbeea8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ My Resume and LaTeX Template ============================ -**Weitian LI** `` - Introduction ------------ This repository holds my [resume](resume-zh+en.pdf) (Chinese and English), @@ -17,21 +15,26 @@ by Alessandro Plasmati. Usage ----- -1. Install XeLaTeX, latexmk, GNU Make, and GhostScript packages; -2. Install [Font Awesome 5](#font-awesome-5) and - other [required fonts](#required-fonts); -3. Replace `resume-zh.tex` and `resume-en.tex` with your versions; -4. Compile to PDFs with a simple `make` :-) - -**NOTE**: -The `TEXINPUTS` environment variable is set in the [Makefile](Makefile#L10) -so that XeLaTeX can find the `resume.cls` template and `fontawesome5.sty` -package. If you don't or can't use this `Makefile`, e.g., on Windows, -then you need to appropriately configure your environment. - -**NOTE**: -I use Windows only a bit, so I don't have a guide to use this template on -Windows. I'm glad to accept suggestions and updates. +* Linux + + 1. Install XeLaTeX, latexmk, GNU Make, and GhostScript packages; + 2. Install [Font Awesome 5](#font-awesome-5) and + other [required fonts](#required-fonts); + 3. Replace `resume-zh.tex` and `resume-en.tex` with your versions; + 4. Compile to PDFs with a simple `make` :-) + +* Windows + + 1. Install [MiKTeX](https://miktex.org/); + 2. Install [Font Awesome 5](#font-awesome-5) and + other [required fonts](#required-fonts); + 3. Copy `fontawesome5/fontawesome5.sty` to the current directory + (i.e., the same directory as `resume.cls` and `resume-*.tex`) + so that it can be auto found; + 4. Replace `resume-zh.tex` and `resume-en.tex` with your versions; + 5. Open `resume-*.tex` in TeXWorks, choose `XeLaTeX` to compile, + and confirm the prompts to install the missing packages along + the run. Font Awesome 5 -------------- -- cgit v1.2.2