summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/bibtex/bath-bst/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/bibtex/bath-bst/README.md')
-rw-r--r--Master/texmf-dist/doc/bibtex/bath-bst/README.md27
1 files changed, 21 insertions, 6 deletions
diff --git a/Master/texmf-dist/doc/bibtex/bath-bst/README.md b/Master/texmf-dist/doc/bibtex/bath-bst/README.md
index 5b5e98eb9c0..cd073944a38 100644
--- a/Master/texmf-dist/doc/bibtex/bath-bst/README.md
+++ b/Master/texmf-dist/doc/bibtex/bath-bst/README.md
@@ -6,12 +6,24 @@ It should be used in conjunction with [natbib] for citations.
## Installation
+The files you need are included in the zip archive available from [GitHub].
+If you use the zip archive from [CTAN], you will need to run `luatex
+bath-bst.dtx` to generate them.
+
You can use this style simply by copying the `bath.bst`/`bathx.bst` files into
your working directory, that is, the directory holding the main `.tex` file for
your document. If you want the style to be available for all your documents
without having to copy it over each time, you can install it using the
instructions below.
+### Managed way
+
+The latest stable release of bath-bst has been packaged for TeX Live and
+MiKTeX. If you are running TeX Live and have `tlmgr` installed, you can install
+the package simply by running `tlmgr install bath-bst`. If you are running
+MiKTeX, you can install the package by running `mpm --install=bath-bst`.
+Both `tlmgr` and `mpm` have GUI versions that you might find friendlier.
+
### Automated way
A makefile is provided which you can use with the Make utility on
@@ -24,7 +36,8 @@ UNIX-like systems:
- `bath-bst.bib` and `bath-bst-v1.bib`
- `bath-bst.ins`
* Running `make` generates the above files and also `bath-bst.pdf` and
- `bath-bst-v1.pdf`.
+ `bath-bst-v1.pdf`. Ensure you have (at least) the [luatexja], [adobemapping]
+ and [ipaex] packages installed first.
* Running `make inst` installs the files in the user's TeX tree.
You can undo this with `make uninst`.
* Running `make install` installs the files in the local TeX tree.
@@ -32,9 +45,9 @@ UNIX-like systems:
### Manual way
-You only need to follow the first two steps if you have made your own
-changes to the .dtx file. The compiled files you need are included in
-the zip archive.
+You do not need to follow the first step if you downloaded the zip archive from
+[GitHub]. You do not need to follow the second step if you already have the PDF
+documentation.
1. Run `luatex bath-bst.dtx` to generate the source files.
@@ -71,8 +84,10 @@ the zip archive.
5. You may then have to update your installation's file name database
before TeX and friends can see the files.
-[bath-harvard]: http://www.bath.ac.uk/library/infoskills/referencing-plagiarism/harvard-bath-style.html
+[bath-harvard]: https://library.bath.ac.uk/referencing/harvard-bath
[BibTeX]: http://ctan.org/pkg/bibtex
+[GitHub]: https://github.com/alex-ball/bathbib/releases
+[CTAN]: http://ctan.org/pkg/bath-bst
[natbib]: http://www.ctan.org/pkg/natbib
[LuaLaTeX]: http://ctan.org/pkg/lualatex-doc
[luatexja]: http://ctan.org/pkg/luatexja
@@ -81,7 +96,7 @@ the zip archive.
## Licence
-Copyright 2016 University of Bath.
+Copyright 2016-2018 University of Bath.
This work consists of the documented LaTeX file bath-bst.dtx and a Makefile.