Skip to content

Commit a045f60

Browse files
committed
Adding compiled version to documentation + adding Get Started! section to readme.
1 parent 18730e7 commit a045f60

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

md_version/main.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,7 @@ This is a sub-paragraph.
110110

111111
## Debugging
112112

113-
If this template does not "work" as expected, feel free to [open an issue](https://github.com/aubertc/au_ccs_dissertation_template/issues) or reach out to [the maintainer](https://spots.augusta.edu/caubert/#contact), after having looked at `aux/input.log` as (probably) indicated by latexmk.
114-
113+
If this template does not "work" as expected, feel free to [open an issue](https://github.com/aubertc/au_ccs_dissertation_template/issues) or reach out to <[email protected]>, after having looked at `aux/input.log` as (probably) indicated by latexmk.
115114

116115
# References and Bibliography
117116

md_version/main.pdf

676 KB
Binary file not shown.

readme.md

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

3+
> [!TIP] Get started!
4+
> 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/>.
5+
> 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].
6+
37
## Presentation
48

59
This template was designed for Ms and PhD students from the [School of Cyber and Computer Sciences](https://www.augusta.edu/ccs/) at [Augusta University](https://www.augusta.edu/) as an alternative to the standard, ["ETD"](https://guides.augusta.edu/ld.php?content_id=64866487) template offered by the Graduate School.
610
Students more comfortable with the `docx` format or not willing to learn to use [LaTeX](https://www.latex-project.org/) and / or [markdown](https://commonmark.org/) should use this standard template instead.
711

812
> [!CAUTION]
913
> The student and their advisor are strongly encouraged to make sure that the manuscript comply with the [Forms, Policies, and Procedures](https://www.augusta.edu/gradschool/student-resources.php) of [Augusta University](https://www.augusta.edu/)'s [Graduate School](https://www.augusta.edu/gradschool/) themselves.
10-
> 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).
14+
> 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).
1115
1216

1317
This template is offered in two versions:
1418

15-
- The [`tex` version](tex_version) is a standard `tex` document that can be compiled using [latexmk](https://mg.readthedocs.io/latexmk.html) or any standard LaTeX distribution,
16-
- The [markdown version](md_version) is a [markdown](https://commonmark.org/) document that can be compiled using [pandoc](https://pandoc.org/).
19+
- 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,
20+
- The markdown version is a [markdown](https://commonmark.org/) document that can be compiled using [pandoc](https://pandoc.org/).
1721

1822
Note that the `tex` version is actually obtained from the markdown version, thanks to pandoc's ability to convert markdown documents into `tex` documents.
1923
This conversion takes place when the markdown version is used to produce the final `pdf` "under the hood", which allows the markdown version to use _both_ the LaTeX and the markdown syntaxes.

0 commit comments

Comments
 (0)