From 2405725149721117da17b64f42ef5d9759583cf3 Mon Sep 17 00:00:00 2001
From: Karl Berry <karl@freefriends.org>
Date: Sun, 26 Nov 2017 23:27:56 +0000
Subject: bib2gls (26nov17)

git-svn-id: svn://tug.org/texlive/trunk@45917 c570f23f-e606-0410-a88d-b1316a301751
---
 Master/texmf-dist/doc/support/bib2gls/README.md | 56 ++++++++++++++++---------
 1 file changed, 36 insertions(+), 20 deletions(-)

(limited to 'Master/texmf-dist/doc/support/bib2gls/README.md')

diff --git a/Master/texmf-dist/doc/support/bib2gls/README.md b/Master/texmf-dist/doc/support/bib2gls/README.md
index 29c9a4a3477..4fb99b7e2c0 100644
--- a/Master/texmf-dist/doc/support/bib2gls/README.md
+++ b/Master/texmf-dist/doc/support/bib2gls/README.md
@@ -3,6 +3,19 @@
 Command line application to convert `.bib` files to
 `glossaries-extra.sty` resource files.
 
+Author: Nicola Talbot (http://www.dickimaw-books.com/)
+
+Application Home Page: http://www.dickimaw-books.com/software/bib2gls
+
+# Licence
+
+License GPLv3+: GNU GPL version 3 or later
+http://gnu.org/licenses/gpl.html
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+
+# Summary
+
 This application may be used to extract glossary information
 stored in a `.bib` file and convert it into glossary entry
 definition commands. This application should be used 
@@ -116,13 +129,16 @@ your local or home TEXMF path (for example, `~/texmf/`):
  - *TEXMF*`/scripts/bib2gls/convertgls2bib.sh` (Unix-like systems
    only.)
  - *TEXMF*`/doc/support/bib2gls/bib2gls.pdf` (User manual.)
+ - *TEXMF*`/doc/support/bib2gls/examples/` (example files)
 
 Note that `texparserlib.jar` isn't an application. It's
 a library used by `bib2gls.jar` and `convertgls2bib.jar`
 and so needs to be on the same class path as them.
 
 The bash `.sh` scripts are provided for Unix-like users.
-They're not required for Windows.
+They're not required for Windows. The `.1` files are `man`
+files and should be placed where `man` can find them. (They
+are created from the `.pod` files.)
 
 To test installation:
 ```bash
@@ -131,26 +147,33 @@ convertgls2bib --version
 ```
 These should display the version details.
 
-#Licence
+# Source Code
 
-License GPLv3+: GNU GPL version 3 or later
-http://gnu.org/licenses/gpl.html
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law.
+Instructions for compiling the manual and jar files are listed
+below. The source is also available on GitHub, but that may be for
+a newer experimental version.
+
+  - https://github.com/nlct/bib2gls
+  - https://github.com/nlct/texparserlib
 
-#Source Code
 
-#User Manual
+## User Manual (bib2gls.pdf)
 
-The documentation `bib2gls.pdf` is compiled using:
+The examples directory needs to be ../examples relative to directory
+containing bib2gls.tex as the .bib, .tex and .pdf files are included
+in the manual.
 
 ```bash
-pdflatex bib2gls
-makeindex -s bib2gls.ist bib2gls
-pdflatex bib2gls
+xelatex bib2gls
+bibtex bib2gls
+bib2gls -g bib2gls
+xelatex bib2gls
+bib2gls -g bib2gls
+xelatex bib2gls
+xelatex bib2gls
 ```
 
-#JAR Files
+## JAR Files
 
 Create the following directories:
 
@@ -203,10 +226,3 @@ cd ../classes
 jar cmf ../java/gls2bib/Manifest.txt ../lib/convertgls2bib.jar
 com/dickimawbooks/gls2bib/*.class
 ```
-
-GitHub:
-
-  - https://github.com/nlct/bib2gls
-  - https://github.com/nlct/texparserlib
-
-Home Page: http://www.dickimaw-books.com/software/bib2gls
-- 
cgit v1.2.3