summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/windycity/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-03-28 20:58:02 +0000
committerKarl Berry <karl@freefriends.org>2019-03-28 20:58:02 +0000
commitdc4136c26b90d63098b63b2be873c7929330296c (patch)
treeffb44c83aba6b9c0cd5bd392fe3c199f04490891 /Master/texmf-dist/doc/latex/windycity/README.md
parent8068d6bf920b15585495660d79164a81382b884a (diff)
windycity (28mar19)
git-svn-id: svn://tug.org/texlive/trunk@50625 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/windycity/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/windycity/README.md55
1 files changed, 44 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/latex/windycity/README.md b/Master/texmf-dist/doc/latex/windycity/README.md
index 8a0ceb4869e..499b3cc1808 100644
--- a/Master/texmf-dist/doc/latex/windycity/README.md
+++ b/Master/texmf-dist/doc/latex/windycity/README.md
@@ -26,28 +26,62 @@ guide](http://mirrors.ctan.org/macros/latex/contrib/biblatex-contrib/windycity/d
If you already know how to use
[biblatex](http://www.ctan.org/pkg/biblatex "biblatex"), getting
-started with Windy City is easy. Locate
-[biblatex](http://www.ctan.org/pkg/biblatex "biblatex") on your
-system, and copy Windy City's files into their respective directories:
+started with Windy City is easy. The first task is to confirm that
+[biblatex](http://www.ctan.org/pkg/biblatex "biblatex") and Windy City
+are installed properly on your system. Since both are included in some
+distributions of [LaTeX](https://en.wikipedia.org/wiki/LaTeX "LaTeX"),
+you might be able to skip this step.
+
+Windy City consists of four files:
+
+* [windycity.dbx](https://github.com/brianchase/windycity/blob/master/windycity.dbx "windycity.dbx")
+* [windycity.bbx](https://github.com/brianchase/windycity/blob/master/bbx/windycity.bbx "windycity.bbx")
+* [windycity.cbx](https://github.com/brianchase/windycity/blob/master/cbx/windycity.cbx "windycity.cbx")
+* [american-windycity.lbx](https://github.com/brianchase/windycity/blob/master/lbx/american-windycity.lbx "american-windycity.lbx")
+
+If you need to install Windy City on your system, you may copy its
+files to one of several places. One option is to locate
+[biblatex](http://www.ctan.org/pkg/biblatex "biblatex") on your system
+and use its directories:
* .../biblatex/[windycity.dbx](https://github.com/brianchase/windycity/blob/master/windycity.dbx "windycity.dbx")
* .../biblatex/bbx/[windycity.bbx](https://github.com/brianchase/windycity/blob/master/bbx/windycity.bbx "windycity.bbx")
* .../biblatex/cbx/[windycity.cbx](https://github.com/brianchase/windycity/blob/master/cbx/windycity.cbx "windycity.cbx")
* .../biblatex/lbx/[american-windycity.lbx](https://github.com/brianchase/windycity/blob/master/lbx/american-windycity.lbx "american-windycity.lbx")
-Next, tell [biblatex](http://www.ctan.org/pkg/biblatex "biblatex") to
-load Windy City with the load-time option `style`:
+If you prefer not to mix Windy City's files with
+[biblatex](http://www.ctan.org/pkg/biblatex "biblatex")'s, another
+option is to find where your distribution of
+[LaTeX](https://en.wikipedia.org/wiki/LaTeX "LaTeX") keeps
+[biblatex](http://www.ctan.org/pkg/biblatex "biblatex")'s third-party
+style files and proceed accordingly. Yet another option is to install
+Windy City in your local `texmf`. Its location will depend on your
+system and preferences. For a one-off compilation, say, to give Windy
+City a trial run on a single document, you can copy Windy City's files
+to the document's root directory.
+
+After copying the files to one of those places — or another of your
+choosing — remember that for every option but the last (a document's
+root directory), you need to update your `texmf` file name database.
+
+To compile a document with Windy City, tell
+[biblatex](http://www.ctan.org/pkg/biblatex "biblatex") to load it
+with the load-time option `style`:
```
\usepackage[style=windycity]{biblatex}
```
+Typically, this goes in a document's preamble or in one of its style
+files.
+
For some entries in your bibliography database, you may need to add
-fields or make other adjustments to get the right output. However,
-since Windy City relies as much as possible on standard BibTeX fields,
-and secondarily on [biblatex](http://www.ctan.org/pkg/biblatex
-"biblatex") fields, you may not need to make major changes. The
-examples in this document and its accompanying bibliography database,
+fields or make other adjustments to get the right output. But since
+Windy City relies as much as possible on standard
+[BibTeX](http://www.bibtex.org "BibTeX") fields, and secondarily on
+[biblatex](http://www.ctan.org/pkg/biblatex "biblatex") fields, you
+may not need to make major changes. The examples in this document and
+its accompanying bibliography database,
[windycity.bib](https://github.com/brianchase/windycity/blob/master/doc/windycity.bib
"windycity.bib"), should serve as a guide for how to manage your input
for nearly every circumstance that the style is meant to handle.
@@ -66,6 +100,5 @@ warranties of merchantability and fitness for a particular purpose.
## Requirements
-* [TeX Live](http://www.tug.org/texlive "TeX Live")
* [biblatex](http://www.ctan.org/pkg/biblatex "biblatex") 3.8 or higher