Skip to content

Commit dc644b3

Browse files
committed
Clarify GitHub install procedure (plk#741)
1 parent 721d99d commit dc644b3

File tree

1 file changed

+34
-18
lines changed

1 file changed

+34
-18
lines changed

README.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ This package provides advanced bibliographic facilities for use with LaTeX.
55
The package is a complete reimplementation of the bibliographic facilities
66
provided by LaTeX. A custom backend Biber is used by default which
77
processes BibTeX format data files and them performs all sorting, label
8-
generation (and a great deal more).
8+
generation (and a great deal more).
99

1010
Biblatex does not use the backend to
1111
format the bibliography information as with traditional BibTeX: instead of
1212
being implemented in BibTeX style files, the formatting of the bibliography
13-
is entirely controlled by TeX macros.
13+
is entirely controlled by TeX macros.
1414

1515
This package supports subdivided
1616
bibliographies, multiple bibliographies within one document with different
1717
sorting, separate lists of bibliographic information such as abbreviations
18-
of various fields.
18+
of various fields.
1919
Bibliographies may be subdivided into parts and / or
20-
segmented by topics.
20+
segmented by topics.
2121

2222
Just like the bibliography styles, all citation
23-
commands may be freely defined.
23+
commands may be freely defined.
2424

2525
With Biber as the backend, features such
2626
as customisable sorting, multiple bibliographies with different sorting,
2727
customisable labels, dynamic data modification and custom data models are
28-
available.
28+
available.
2929

3030
The package is completely localised and can interface with
3131
the Babel and Polyglossia packages. Read below for how to
@@ -50,7 +50,8 @@ This work has the LPPL maintenance status "maintained".
5050

5151
# Installation
5252

53-
biblatex is bundled with TeXLive and its variants.
53+
biblatex is bundled with TeXLive and its variants as well as MikTeX.
54+
Normally you can install and update biblatex through your TeX distribution.
5455

5556
biblatex starts life on Github where you can always find development
5657
releases:
@@ -68,29 +69,44 @@ get the latest stable version:
6869

6970
[https://ctan.org/pkg/biblatex](https://ctan.org/pkg/biblatex)
7071

71-
Installation from github
72+
## Installation from github
7273

7374
For this you'll need to be on a UNIX-like system (use
7475
[https://www.cygwin.com](cygwin) on Windows) that has bash and perl.
7576

76-
First clone the repo:
77-
78-
`git clone https://github.com/plk/biblatex.git`
77+
You should only install from github if you want to check out the bleeding edge
78+
of development or if there is absolutely no way to obtain either the official
79+
historical releases from
80+
[SourceForge](https://sourceforge.net/projects/biblatex/files/)
81+
or the current release from [CTAN](https://www.ctan.org/pkg/biblatex).
82+
Remember that you will need a matching Biber version (the binaries are
83+
distributed on [SourceForge](https://sourceforge.net/projects/biblatex-biber/files/biblatex-biber/)).
7984

85+
First clone the repo:
86+
```
87+
git clone https://github.com/plk/biblatex.git
88+
```
8089
Then from the clone root:
81-
82-
`obuild/build.sh install <version> <texmf root>`
83-
90+
```
91+
obuild/build.sh install <version> <texmf root>
92+
```
8493
for example, say the currently released version is 3.3 and you want to try
8594
the 3.4 development version. Suppose your personal texmf root is at
8695
`~/texmf`:
87-
88-
`obuild/build.sh install 3.4 ~/texmf`
89-
96+
```
97+
obuild/build.sh install 3.4 ~/texmf
98+
```
9099
If this is the first time you are installing `biblatex` into `~/texmf`, you will have
91100
to tell TeX that it can find the files in this new location with `texhash`
92101
or the equivalent command from your TeX distribution.
93102

103+
Note that the install script does not fetch and install the official biblatex
104+
release version corresponding to the version argument supplied. It just takes
105+
the files that are currently checked out, moves them and changes their version
106+
identifications so that they identify as the version given in the argument.
107+
If you want a specific version, you must check out the corresponding tag or
108+
obtain the corresponding sources otherwise before running the script.
109+
94110
Obviously, its is easier to get the TDS format package from the Sourceforge
95111
development folder and just unpack it into your `~/texmf` but this might
96112
not be quite as recent as the git development branch (but is usually very
@@ -134,5 +150,5 @@ Suggestions and bug reports are welcome.
134150

135151
- Go to the Github [issues page](https://github.com/plk/biblatex/issues).
136152
- Open an issue.
137-
- Add a [minimal working example](http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minxampl) if
153+
- Add a [minimal working example](http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minxampl) if
138154
possible. This helps a great deal facilitate a swift response.

0 commit comments

Comments
 (0)