Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #985

Merged
merged 2 commits into from
Dec 30, 2024
Merged

Update documentation #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b0e3ec
Add information for newcomers in README.md
Gravifer Dec 30, 2024
b4e4b71
Fix typo in thuthesis.dtx
Gravifer Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# ThuThesis

Scroll down for the English version of README.
> Scroll down for the English version of README.

**ThuThesis** 是 **T**sing**h**ua **U**niversity **Thesis** LaTeX Template 的缩写。

Expand Down Expand Up @@ -35,7 +35,7 @@ Scroll down for the English version of README.
* [TUNA 镜像站](https://mirrors.tuna.tsinghua.edu.cn/github-release/tuna/thuthesis/)：GitHub Releases 的镜像。
* 在线编辑：
* [TeXPage 模板](https://www.texpage.com/template/72b580ca-51fa-4ecc-82b3-0509bc1d6a07)（提供 Windows 中文字体）
* [Overleaf 模板](https://www.overleaf.com/latex/templates/thuthesis-tsinghua-university-thesis-latex-template/cfwgcxtvkbsx)
* [Overleaf 模板](https://www.overleaf.com/latex/templates/thuthesis-tsinghua-university-thesis-latex-template/cfwgcxtvkbsx) （[Overleaf 降低了免费账户的编译时间](https://www.overleaf.com/blog/changes-to-free-compile-timeouts-and-servers)， 使用本模板的项目会因为规模较大[容易超时](https://github.com/tuna/thuthesis/issues/984)）
* 开发版：[GitHub](https://github.com/tuna/thuthesis)

### 注意事项
Expand Down Expand Up @@ -73,6 +73,7 @@ Scroll down for the English version of README.
* 先到 [FAQ](https://github.com/tuna/thuthesis/wiki/FAQ) 看看常见问题；
* 在 [GitHub Discussions](https://github.com/tuna/thuthesis/discussions) 搜索已有讨论，如果没有则提出新问题；
* 如果认为模板存在问题，可在 Issues 中使用相应的模板提出。
* 入门问题可以参考[wiki/新手指南](https://github.com/tuna/thuthesis/wiki/新手指南)学习

## Makefile的用法

Expand Down Expand Up @@ -117,7 +118,7 @@ Before you start writing, it is recommended to copy or rename `thuthesis-example
* [TUNA Mirrors](https://mirrors.tuna.tsinghua.edu.cn/github-release/tuna/thuthesis/): mirror of GitHub Releases
* Online editor:
* [TeXPage template](https://www.texpage.com/template/72b580ca-51fa-4ecc-82b3-0509bc1d6a07) (providing Chinese fonts of Windows)
* [Overleaf template](https://www.overleaf.com/latex/templates/thuthesis-tsinghua-university-thesis-latex-template/cfwgcxtvkbsx)
* [Overleaf template](https://www.overleaf.com/latex/templates/thuthesis-tsinghua-university-thesis-latex-template/cfwgcxtvkbsx) ([free compile time was reduced](https://www.overleaf.com/blog/changes-to-free-compile-timeouts-and-servers); projects using this template will be relatively large, and thus [likely to time-out](https://github.com/tuna/thuthesis/issues/984))
* Developer versions: [GitHub](https://github.com/tuna/thuthesis)

### Notes
Expand Down Expand Up @@ -155,6 +156,7 @@ Please follow the procedure below:
* Check the [FAQ](https://github.com/tuna/thuthesis/wiki/FAQ).
* Search [GitHub Discussions](https://github.com/tuna/thuthesis/discussions) and create if not existed.
* Create an issue (with specified template) if you believe there is a bug.
* Beginners may go to [wiki/新手指南](https://github.com/tuna/thuthesis/wiki/新手指南) for basic information.

## Makefile Usage

Expand Down
2 changes: 1 addition & 1 deletion thuthesis.dtx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -835,7 +835,7 @@
% \item \DescribeOption{math-ellipsis}
% 省略号 \cs{dots} 的样式，可选：\option{centered}（按照中文的习惯固定居中）、
% \option{lower} 和 \option{AMS}（取决于前后符号的位置）。
% 其他的省略号命令如 \cs{lots}、\cs{cdots} 则不受影响。
% 其他的省略号命令如 \cs{ldots}、\cs{cdots} 则不受影响。
% \item \DescribeOption{real-part}
% 实部 \cs{Re} 和虚部 \cs{Im} 的字体，可选：\option{roman} 和 \option{fraktur}。
% \end{enumerate}
Expand Down
Loading