补充中英文 README 的 Overleaf 在线编译说明

This commit is contained in:
2026-07-24 12:28:15 +08:00
parent 8851a2167b
commit 23eac331fb
2 changed files with 42 additions and 12 deletions
+21 -6
View File
@@ -4,6 +4,8 @@
This repository provides a LaTeX template for Chinese technical reports. It is suitable for documenting project design, implementation details, test results, troubleshooting records, FAQs, and future plans. A blank template and two complete examples are included for direct reuse.
If you prefer not to install and configure LaTeX locally, use [Overleaf](https://www.overleaf.com/) to edit and compile the template online. Overleaf offers a free plan and requires no local installation: create an account, upload the template, and start editing.
## Features
- A4 paper, 12 pt text, 2.5 cm margins, and 1.5 line spacing
@@ -33,9 +35,23 @@ This repository provides a LaTeX template for Chinese technical reports. It is s
└─ README_en.md
```
## Requirements
## Recommended: Compile Online with Overleaf
Install a LaTeX distribution that includes XeLaTeX, such as TeX Live or MiKTeX. The template uses `ctex` for Chinese typesetting and depends on the following packages:
For new LaTeX users or anyone who does not want to configure a local toolchain, the Overleaf free plan is generally sufficient for editing and compiling this template.
1. Create a ZIP archive containing `main.tex` from the `模板` directory. Keep `main.tex` at the root of the archive.
2. Sign in to Overleaf and select **New Project → Upload Project** to upload the ZIP file.
3. Open **Menu** in the upper-left corner and set **Compiler** to **XeLaTeX**.
4. Edit `main.tex`, then click **Recompile** to generate the PDF.
5. Download the generated PDF or the complete project source when a local copy is needed.
When using an example document, include its `main.tex` and PNG images in the same ZIP archive; otherwise, the images will be missing. See the [official Overleaf upload guide](https://www.overleaf.com/learn/latex/Kb/Uploading_a_project) for details.
> The Overleaf free plan has resource limits such as a compile timeout, but it is normally sufficient for the technical reports in this repository. If a long document, complex content, or large images reach those limits, optimize the images or compile locally.
## Local Compilation Requirements
Install a LaTeX distribution only if offline compilation is required. Use a distribution that includes XeLaTeX, such as TeX Live or MiKTeX. The template uses `ctex` for Chinese typesetting and depends on the following packages:
```text
ctex, geometry, titlesec, titletoc, fancyhdr, listings,
@@ -60,7 +76,7 @@ A full TeX Live installation normally includes these packages. With a minimal in
```
3. Edit, duplicate, or remove the sample sections as needed.
4. Run XeLaTeX twice so that the table of contents and cross-references are updated:
4. Upload the document to Overleaf and select XeLaTeX as the compiler, or run XeLaTeX locally twice so that the table of contents and cross-references are updated:
```powershell
xelatex main.tex
@@ -73,7 +89,7 @@ A full TeX Live installation normally includes these packages. With a minimal in
latexmk -xelatex main.tex
```
5. Open `main.pdf` in the current directory.
5. View or download the result from Overleaf's PDF preview. For local compilation, open `main.pdf` in the current directory.
## Common Elements
@@ -139,7 +155,7 @@ Both example directories include compiled PDF files, allowing the final layout t
### Chinese text is not rendered correctly
Make sure the document is compiled with XeLaTeX rather than the traditional LaTeX command, and verify that Chinese language support and `ctex` are installed.
Make sure XeLaTeX is selected in the Overleaf project menu or used by the local compile command. For local compilation, also verify that Chinese language support and `ctex` are installed.
### A package cannot be found
@@ -156,4 +172,3 @@ Check the file name, extension, and relative path. When moving or copying an exa
## License Note
No license file is currently included in this repository. Add an appropriate license or an internal-use notice before redistribution.