summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md31
1 files changed, 18 insertions, 13 deletions
diff --git a/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md b/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md
index 16081260ac4..e97074c4aa2 100644
--- a/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md
+++ b/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md
@@ -1,13 +1,10 @@
-# Cover page for scientific works
-
-[![Build Status](https://circleci.com/gh/latextemplates/scientific-thesis-cover/tree/master.svg?style=shield)](https://circleci.com/gh/latextemplates/scientific-thesis-cover/)
-
+# Cover page for scientific works [![Build Status](https://circleci.com/gh/latextemplates/scientific-thesis-cover/tree/master.svg?style=shield)](https://circleci.com/gh/latextemplates/scientific-thesis-cover/) [![CTAN](https://img.shields.io/badge/CTAN-scientific--thesis--cover-blue.svg?style=flat-square)](https://ctan.org/pkg/scientific-thesis-cover)
Institutions require a cover page and an affirmation at the end of the thesis.
-This work provides both.
+This package provides both.
It stems from the [computer science institutes of the University of Stuttgart], but is open to any university.
-In case you are looking for a **full thesis template** including a cover page and affirmation, please go to <https://github.com/latextemplates/scientific-thesis-template>.
+In case you are looking for a **full thesis template** including a cover page and affirmation, please go to <https://latextemplates.github.io/scientific-thesis-template/>.
Please report issues concerning this package at the GitHub repository at <https://github.com/latextemplates/scientific-thesis-cover>.
## Features
@@ -17,13 +14,16 @@ Please report issues concerning this package at the GitHub repository at <https:
## Installation
-- Download `scientific-thesis-cover.sty`
+Usually, one does not need a seperate installation step, because both MiKTeX and texlive come with a recent version of this template.
+Do not forget to [keep your tex distribution updated](https://tex.stackexchange.com/q/55437/9075).
+
+Alternatively, you can download `scientific-thesis-cover.sty` and put it in the folder where you are going to use it.
## Usage Example
-An example can be found in [tests/TEST_english_oneside.tex](tests/TEST_english_oneside.tex).
+An example can be found in [demo.tex](demo.tex).
-## Usage
+## Usage
Just include the package with all options specified:
@@ -126,16 +126,21 @@ Multiline/Commands in option values are currently only supported if you load `kv
## How to release
+1. Check if indent is correct: `latexindent -y="indentPreamble:1,defaultIndent:' '" -m -w scientific-thesis-cover.sty`
1. Adapt `CHANGELOG.md`
2. Adapt version and date in `scientific-thesis-cover.sty`
3. Tag the release commit using `git tag`
4. Push to GitHub
5. Add CHANGELOG part to GitHub release manually, because [github-release-from-changelog](https://github.com/MoOx/github-release-from-changelog) currently works with `package.json` only.
6. Publish to CTAN
- - Windows: Patch `C:\MiKTeX\scripts\ctanify\ctanify`: Remove `-y` from `zip` command line arguments `zip -q -r -9 -y -m`.
- - Run `pdflatex demo`
- - Run `perl "C:\MiKTeX\scripts\ctanify\ctanify" README.md scientific-thesis-cover.sty demo.pdf`
- - Go to <https://www.ctan.org/upload> and use `scientific-thesis-cover.tar.gz` as archive.
+ - Pre-conditions:
+ - Windows: Patch `C:\MiKTeX\scripts\ctanify\ctanify`: Remove `-y` from `zip` command line arguments `zip -q -r -9 -y -m`.
+ - Windows: Environment variable `TMP` must not contain backslashes. E.g., `C:/TEMP/WIN` is good, `C:\Users\user\AppData\Local\Temp` is bad.
+ - Have `pandoc` and `sed` in the path.
+ - Run `release.bat`.
+ - Go to <https://ctan.org/pkg/scientific-thesis-cover>, choose "Upload"
+ - Use `scientific-thesis-cover.tar.gz` as archive.
+7. Adapt `CHANGELOG.md` to contain `## [unreleased]` again.
## License