summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/biblatex-bath/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/biblatex-bath/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/biblatex-bath/README.md32
1 files changed, 24 insertions, 8 deletions
diff --git a/Master/texmf-dist/doc/latex/biblatex-bath/README.md b/Master/texmf-dist/doc/latex/biblatex-bath/README.md
index 30a82e70ae8..a6419b1512b 100644
--- a/Master/texmf-dist/doc/latex/biblatex-bath/README.md
+++ b/Master/texmf-dist/doc/latex/biblatex-bath/README.md
@@ -5,12 +5,24 @@ This package provides a [biblatex] style to format reference lists in the
## 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
+biblatex-bath.dtx` to generate them.
+
You can use this style simply by copying all the `.bbx`, `.cbx`, `.dbx` and
`.lbx` 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 the files over each time, you can
install them using the instructions below.
+### Managed way
+
+The latest stable release of biblatex-bath 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 biblatex-bath`. If you are running
+MiKTeX, you can install the package by running `mpm --install=biblatex-bath`.
+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
@@ -19,10 +31,12 @@ UNIX-like systems:
* Running `make source` generates the derived files
- `README.md`
- `bath.bbx`, `bath.cbx`, `bath.dbx`
- - `american-bath.lbx`, `british-bath.lbx`
+ - `english-bath.lbx`, `british-bath.lbx`
- `biblatex-bath.bib`
- `biblatex-bath.ins`
- * Running `make` generates the above files and also biblatex-bath.pdf.
+ * Running `make` generates the above files and also `biblatex-bath.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.
@@ -30,9 +44,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 biblatex-bath.dtx` to generate the source files.
@@ -61,7 +75,7 @@ the zip archive.
`bath.bbx`,
`bath.cbx`,
`bath.dbx`,
- `american-bath.lbx`,
+ `english-bath.lbx`,
`british-bath.lbx`
- `doc/latex/biblatex-bath`:
`biblatex-bath.pdf`,
@@ -70,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
[biblatex]: http://ctan.org/pkg/biblatex
+[GitHub]: https://github.com/alex-ball/bathbib/releases
+[CTAN]: http://ctan.org/pkg/biblatex-bath
[LuaLaTeX]: http://ctan.org/pkg/lualatex-doc
[Biber]: http://ctan.org/pkg/biber
[luatexja]: http://ctan.org/pkg/luatexja
@@ -80,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 biblatex-bath.dtx and a Makefile.