summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/physconst/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-02-04 03:01:28 +0000
committerNorbert Preining <norbert@preining.info>2020-02-04 03:01:28 +0000
commitfc358ce7332053945afe16ced2a271556cdccfb7 (patch)
treed723e8bbffaaffd6c8c6d51d46c54db70c61f67a /macros/latex/contrib/physconst/README.md
parent34897eebd22c3de968b64f09bb4a371d96cb0b89 (diff)
CTAN sync 202002040301
Diffstat (limited to 'macros/latex/contrib/physconst/README.md')
-rw-r--r--macros/latex/contrib/physconst/README.md35
1 files changed, 23 insertions, 12 deletions
diff --git a/macros/latex/contrib/physconst/README.md b/macros/latex/contrib/physconst/README.md
index 8a43c78f49..8727bf5e43 100644
--- a/macros/latex/contrib/physconst/README.md
+++ b/macros/latex/contrib/physconst/README.md
@@ -16,7 +16,8 @@ and version 1.3c or later is part of all distributions of LaTeX
version 2006/05/20 or later.
# Dependencies
-- [`physunits` package](https://github.com/astrobit/physunits) also available at [CTAN](https://ctan.org)
+- [`physunits` package](https://github.com/astrobit/physunits) also available
+at [CTAN](https://ctan.org)
# Build Dependencies
- some LaTeX distribution.
@@ -27,7 +28,8 @@ version 2006/05/20 or later.
# Files
```
- makefile GNU makefile to simplify building and installation on linux
+ makefile GNU makefile to simplify building and installation
+ on linux
README.md This file.
CHANGELOG.md List of changes
physconst.ins The installer file
@@ -40,28 +42,37 @@ version 2006/05/20 or later.
1. `make`
## Otherwise
-1. Run `latex` on `physconst.ins` to create the `.sty` file. e.g. `latex physconst.ins`.
+1. Run `latex` on `physconst.ins` to create the `.sty` file. e.g.
+`latex physconst.ins`.
1. The following steps apply only if you want the documentation (recommended).
- 1. Run `latex` on `physconst.dtx` to create the `.pdf` file. e.g. `xelatex physconst.pdf`.
- 1. Run `makeindex` to create the index, e.g. `makeindex -s gind.ist -o physconst.ind physconst.idx`.
- 1. Run `makeindex` to create the change log, e.g. `makeindex -s gglo.ist -o physconst.gls physconst.glo`.
- 1. Run `latex` on `physconst.dtx` to create the `.pdf` file with index and change log. e.g. `xelatex physconst.pdf`.
- 1. Run `latex` on `physconst.dtx` to get the labels sorted out. e.g. `xelatex physconst.pdf`.
-
-Instructions that might help can be for windows can be found at [this post on StackExchange](https://tex.stackexchange.com/questions/369921/loading-packages-with-ins-and-dtx-files).
+ 1. Run `latex` on `physconst.dtx` to create the `.pdf` file. e.g.
+`xelatex physconst.pdf`.
+ 1. Run `makeindex` to create the index, e.g.
+`makeindex -s gind.ist -o physconst.ind physconst.idx`.
+ 1. Run `makeindex` to create the change log, e.g.
+`makeindex -s gglo.ist -o physconst.gls physconst.glo`.
+ 1. Run `latex` on `physconst.dtx` to create the `.pdf` file with index and
+change log. e.g. `xelatex physconst.pdf`.
+ 1. Run `latex` on `physconst.dtx` to get the labels sorted out. e.g.
+`xelatex physconst.pdf`.
+
+Instructions that might help can be for windows can be found at
+[this post on StackExchange](https://tex.stackexchange.com/questions/369921/loading-packages-with-ins-and-dtx-files).
# Installation
First build the project as described above.
## For a single project
-1. Copy the `physconst.sty` into your project where your `.tex` files are located.
+1. Copy the `physconst.sty` into your project where your `.tex` files are
+located.
## for all users and projects
### Linux / Mac using make and xelatex
1. `make localinstall`
### Otherwise
-Instructions that might help can be for windows can be found at [this post on StackExchange](https://tex.stackexchange.com/questions/369921/loading-packages-with-ins-and-dtx-files).
+Instructions that might help can be for windows can be found at
+[this post on StackExchange](https://tex.stackexchange.com/questions/369921/loading-packages-with-ins-and-dtx-files).
1. Figure out where your LaTeX local packages are installed.
1. Create a directory named `physconst` in that location.
1. Copy the `.sty` file into the directory you just created.