summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/thesis-gwu/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/thesis-gwu/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/thesis-gwu/README.md28
1 files changed, 24 insertions, 4 deletions
diff --git a/Master/texmf-dist/doc/latex/thesis-gwu/README.md b/Master/texmf-dist/doc/latex/thesis-gwu/README.md
index d863fbae0bb..fc67f8e5163 100644
--- a/Master/texmf-dist/doc/latex/thesis-gwu/README.md
+++ b/Master/texmf-dist/doc/latex/thesis-gwu/README.md
@@ -1,25 +1,45 @@
-| Build Status | Latest Release | Version | Last Commit | Activity |
-| :--------------------------------------: | :--------------------------: | :----: | :------: | :------: |
-| [![Travis][travis_shield]][travis] | [![Github Release][release_shield]][github_release] | [![Github Version][version_shield]][github_version] | [![Github Last Commit][last_commit_shield]][github_last_commit] | [![Github commit activity][activity_shield]][github_activity] |
-
+| Build Status | Latest Release | Version | Last Commit | Activity | CTAN |
+| :--------------------------------------: | :--------------------------: | :----: | :------: | :------: | :----: |
+| [![Travis][travis_shield]][travis] | [![Github Release][release_shield]][github_release] | [![Github Version][version_shield]][github_version] | [![Github Last Commit][last_commit_shield]][github_last_commit] | [![Github commit activity][activity_shield]][github_activity] | [![CTAN][ctan_shield]][ctan] |
[travis_shield]: https://travis-ci.org/skulumani/thesis-gwu.svg?branch=master
[release_shield]: https://img.shields.io/github/release/skulumani/thesis-gwu.svg
[version_shield]: https://badge.fury.io/gh/skulumani%2Fthesis-gwu.svg
[last_commit_shield]: https://img.shields.io/github/last-commit/skulumani/thesis-gwu.svg
[activity_shield]: https://img.shields.io/github/commit-activity/y/skulumani/thesis-gwu.svg
+[ctan_shield]: https://img.shields.io/ctan/v/tex.svg
[travis]: https://travis-ci.org/skulumani/thesis-gwu
[github_release]: https://github.com/skulumani/thesis-gwu/releases/latest
[github_version]: https://github.com/skulumani/thesis-gwu/releases/latest
[github_last_commit]: https://github.com/skulumani/thesis-gwu/commits/master
[github_activity]: https://github.com/skulumani/thesis-gwu/graphs/commit-activity
+[ctan]: https://ctan.org/pkg/thesis-gwu
## [GWU Thesis](https://skulumani.github.io/2016/10/thesis-gwu)
This is a GWU SEAS thesis template.
It complies with the requirements as laid out by the [ETD](http://library.gwu.edu/etd/formatting-content).
+### Installing
+
+You can install this thesis class in one of two ways:
+
+1. Clone/Download this repo onto your computer, and use
+
+~~~
+\documentclass[path/to/thesis-gwu]
+~~~
+
+2. Install thesis-gwu from CTAN
+
+~~~
+tlmgr install thesis-gwu
+~~~
+
+Which will download this class file to your computer and install it appropriately.
+Any document on your machine can then use `thesis-gwu`
+
### Building the PDF
To build the document, it is easiest to use the great [`latexmk`](http://mg.readthedocs.io/latexmk.html) by simply running: