Skip to content

Commit

Permalink
docs: add some info about install and usage, provide Overleaf link.
Browse files Browse the repository at this point in the history
fix: #1.
  • Loading branch information
fky2015 committed Jan 8, 2023
1 parent 5def080 commit 67c75aa
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

A LaTeX resume designed for optimal information density and aesthetic appeal.

一个旨在实现最佳的信息密度和美学吸引力的 LaTeX 简历排版项目。

## 包依赖

如果你使用 TeXLive 发行版,可以直接使用本项目,无需手动安装依赖。

否则,请确保以下依赖安装。

- geometry
- fancyhdr
- enumitem
Expand All @@ -17,12 +21,21 @@ A LaTeX resume designed for optimal information density and aesthetic appeal.

## 使用方法

### 本地编译

0. 确保已经安装 LaTeX 发行版。
1. 克隆或下载本项目代码。
2. 直接运行 `latexmk` 即可。

### Overleaf 在线平台

直接访问并复制[此项目][overleaf]即可。

## 致谢

该项目主要受到 https://github.com/hijiangtao/resume 的启发,
并基于“提高一页简历中的信息密度”这一排版思路而进一步改进,
并采用 $\LaTeX3$ 写成。


[overleaf]: https://www.overleaf.com/read/ygxtzycvwyqm

0 comments on commit 67c75aa

Please sign in to comment.