Skip to content

Commit 07e5e27

Browse files
committed
Finishing up readme.
1 parent 7e0c55e commit 07e5e27

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

readme.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Augusta University School of Computer and Cyber Sciences Ms and PhD Template
22

3-
> [!TIP]
4-
> **Getting Started**
5-
>
6-
> Download md_version.zip or tex_version.zip to write your thesis in markdown or latex from <https://github.com/the-au-forml-lab/au_ccs_dissertation_template/releases/latest/>.
7-
>
8-
> You are welcome to reach out to <[email protected]> or through [github's issue tracker](https://github.com/the-au-forml-lab/au_ccs_dissertation_template/issues) if you have questions, preferably after reading the instructions below and the [additional documentation][md_version/main.pdf].
3+
## Quick Start
4+
5+
Download `md_version.zip` or `tex_version.zip` to write your thesis in markdown or latex from <https://github.com/the-au-forml-lab/au_ccs_dissertation_template/releases/latest/>.
6+
7+
You are welcome to reach out to <[email protected]> or through [github's issue tracker](https://github.com/the-au-forml-lab/au_ccs_dissertation_template/issues) if you have questions, preferably after reading the instructions below and the [additional documentation](md_version/main.pdf).
98

109
## Presentation
1110

@@ -17,7 +16,7 @@ Students more comfortable with the `docx` format or not willing to learn to use
1716
> This template was developed with extreme care, and students and advisors are encouraged to report any mismatch or issue they may encounter, to <[email protected]> or through [github's issue tracker](https://github.com/the-au-forml-lab/au_ccs_dissertation_template/issues).
1817
1918

20-
This template is offered in two versions:
19+
This template is offered in two versions, at <https://github.com/the-au-forml-lab/au_ccs_dissertation_template/releases/latest/>:
2120

2221
- The `tex` version is a standard `tex` document that can be compiled using [latexmk](https://mg.readthedocs.io/latexmk.html) or any standard LaTeX distribution,
2322
- The markdown version is a [markdown](https://commonmark.org/) document that can be compiled using [pandoc](https://pandoc.org/).
@@ -37,7 +36,7 @@ The `tex` version of this template can be compiled using [latexmk](https://mg.re
3736

3837
latexmk -pdf -xelatex main.tex
3938

40-
in the tex_version folder. The "main.tex" document is "standalone" in the sense that it is not divided into smaller `tex` files, but students should feel free to split it by using the [`\input{…}` and `\include{…}` commands](https://tex.stackexchange.com/q/246/34551).
39+
in the `tex_version` folder. The "main.tex" document is "standalone" in the sense that it is not divided into smaller `tex` files, but students should feel free to split it by using the [`\input{…}` and `\include{…}` commands](https://tex.stackexchange.com/q/246/34551).
4140

4241

4342
Start by looking for
@@ -60,7 +59,7 @@ The markdown version of this template can be compiled using [pandoc](https://pan
6059

6160
make
6261

63-
in the md_version folder.
62+
in the `md_version` folder.
6463

6564
Start by editing the file info/info.tex with your information.
6665

@@ -72,12 +71,10 @@ Start by editing the file info/info.tex with your information.
7271
- [latexmk](https://mg.readthedocs.io/latexmk.html) ([version 4.74. or higher](https://github.com/aubertc/au_ccs_dissertation_template/issues/1), it is possible that it is already part of your LaTeX installation),
7372
- [entr](https://github.com/eradman/entr) if you want to use the command `make watch` that automatically re-compile your source when it is saved.
7473

75-
7674
## Additional Information
7775

7876
Please, refer to the [Thesis/PhD Dissertation Preparation Booklet](https://www.augusta.edu/gradschool/documents/thesis-dissertation-preparation-booklet.pdf) from the graduate school and the University Libraries for additional information, tips and advises.
7977

80-
8178
## Credits and Licence
8279

8380
- This template was created taking inspiration from Augusta University's [Biostat dissertation template](https://guides.augusta.edu/ld.php?content_id=78256224).

0 commit comments

Comments
 (0)