From a29b1777015f98173449c385c69f2266263f2223 Mon Sep 17 00:00:00 2001 From: yujie6 Date: Tue, 5 Nov 2019 09:05:57 +0800 Subject: [PATCH] README: Update (sjtug#436) --- README.md | 9 +++++++++ README_en-US.md | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/README.md b/README.md index 46042197..1cc74998 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,15 @@ | sjtuthesis.tds.zip | 按 TDS(TeX Directory Structure)组织的压缩包 | | sjtuthesis.pdf | 模版的使用文档 | +请务必仔细阅读模板的使用文档前三小节。请不要直接使用 + +```bash +xelatex thesis.tex +``` + +进行编译。推荐使用已经写好的`Makefile`,Windows用户请使用配套的 +`compile.bat`。 + ### Overleaf [Overleaf](https://www.overleaf.com?r=b3b31f49&rm=d&rs=b) 用户可以从下面的模版链接创建自己的项目。 diff --git a/README_en-US.md b/README_en-US.md index e83da593..6194498e 100644 --- a/README_en-US.md +++ b/README_en-US.md @@ -23,6 +23,16 @@ We'd recommend to use packed files downloaded from [Releases](https://github.com | sjtuthesis.tds.zip | TDS(TeX Directory Structure)package | | sjtuthesis.pdf | Document for SJTUThesis | +Please read `sjtuthesis.pdf` carefully before using the template. And do not +use `xelatex` to compile `thesis.tex` directly: + +```bash +xelatex thesis.tex +``` + +We highly recommend using `Makefile` or `compile.bat`(for Windows users) +to compile. + ### Overleaf [Overleaf](https://www.overleaf.com?r=b3b31f49&rm=d&rs=b) users are able to create project from the template link below.