Skip to content

Commit

Permalink
docs: make README.md more friendly
Browse files Browse the repository at this point in the history
  • Loading branch information
github-young authored Dec 4, 2023
1 parent 799f38d commit 92155b4
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,25 @@

HKUST Thesis template for RPG students implemented with LaTeX3.

This template follows the guidelines from HKUST FYTGS [website](https://fytgs.hkust.edu.hk/academics/Academic-Regulations-and-Requirements/Handbook-for-Research-Postgraduate-Studies/guidelines-thesis-preparation) and the formatting instructions of the sample pages ([MPhil](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_mphil.pdf)/[PhD](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_phd.pdf)) provided by FYTGS.
## Getting started

## Get started
Try this template online on [Overleaf](https://www.overleaf.com/latex/templates/hkustthesis/mstwvckmhmjg) in 1 minute! You only need to do 2 things:

Try this template online on [Overleaf](https://www.overleaf.com/latex/templates/hkustthesis/mstwvckmhmjg) in 1 mintue!
1. Remember to change the `Compiler` to **`XeLaTeX`** via the top left `Menu` button, otherwise it won't compile.
2. Download and read carefully the **[PDF documentation](https://github.com/HKFoggyU/hkust-thesis/releases/latest/download/hkustthesis.pdf)** before you edit your thesis.

Remember to change the `Compiler` to **`XeLaTeX`** via the top left `Menu` button, otherwise it won't build.

## Documentation

Are you an experienced user of LaTeX?
- Yes: Please read the [online documentation](https://HKFoggyU.github.io/hkust-thesis/) and the `` dtx `` document.
- No: Are you a patient reader?
- Yes: Please read the **very detailed [PDF documentation](https://github.com/HKFoggyU/hkust-thesis/releases/latest/)** (``hkustthesis-v*.pdf`` in `` Assets `` in the latest release).
- No: Please use Microsoft Word.
Alternatively, you can download the release file and try it on your local machine.

## Contributions

If you find any problems or have any suggestions, please file an issue or PR.

## Disclaimer

FYTGS doesn't provide any template for thesis submission. They only emphasize that the submitted PDF file should meet the requirements in the [RPG Handbook](https://fytgs.hkust.edu.hk/academics/Academic-Regulations-and-Requirements/Handbook-for-Research-Postgraduate-Studies/guidelines-thesis-preparation).

This template has tried its best to follow the above requirements in the RPG Handbook and also the formatting instructions of the sample pages ([MPhil](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_mphil.pdf)/[PhD](https://fytgs.hkust.edu.hk/sites/default/files/imce/thesis_sample_page_phd.pdf)) provided by the RPG Handbook. However, this template takes no responsibility for any potential inconsistency.

## License

LaTeX Project Public License (version 1.3c)
Expand Down

0 comments on commit 92155b4

Please sign in to comment.