summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/physconst/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-01-28 03:01:26 +0000
committerNorbert Preining <norbert@preining.info>2020-01-28 03:01:26 +0000
commitfdd916a9e0d94bbf49f74c3b796e1bab88964d4c (patch)
tree606c1be4716998b353277312e85239fb2739d7c8 /macros/latex/contrib/physconst/README.md
parent685e467506870702d416d2317ce1d808e8f3fb60 (diff)
CTAN sync 202001280301
Diffstat (limited to 'macros/latex/contrib/physconst/README.md')
-rw-r--r--macros/latex/contrib/physconst/README.md80
1 files changed, 46 insertions, 34 deletions
diff --git a/macros/latex/contrib/physconst/README.md b/macros/latex/contrib/physconst/README.md
index 67dd9a8073..8a43c78f49 100644
--- a/macros/latex/contrib/physconst/README.md
+++ b/macros/latex/contrib/physconst/README.md
@@ -16,57 +16,69 @@ 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)
+- [`physunits` package](https://github.com/astrobit/physunits) also available at [CTAN](https://ctan.org)
# Build Dependencies
-- the `xastro-1` library (part of [xlibs][https://github.com/astrobit/xlibs])
-- some LaTeX distribution with `xelatex`. The makefile assumes you have texlive.
-- `pkg-config`
-- GNU c++ compiler (`g++`) with at least c++11
+- some LaTeX distribution.
- `hyperref` package for LaTeX
- `xcolor` package for LaTeX
- `mdframed` package for LaTeX
- `imakeidx` package for LaTeX
-- GNU `make`
# Files
```
+ makefile GNU makefile to simplify building and installation on linux
README.md This file.
CHANGELOG.md List of changes
physconst.ins The installer file
- makefile GNU makefile to create and install the package
- generator/makefile GNU makefile to create the generator
- generator/physconst.cpp c++ source code that will generate the .dtx for the
- package
+ physconst.dtx The package code and documentation
+ physconst.pdf The package user manual
```
-# Distributable Files
-The following distributable files can be created as described below.
-```
- physconst.sty The actual package
- physconst.pdf Usage documentation
- physconst.tar.bz2 Tarball containing package, documentation, and
- this README
- physconst.zip Zip file containing package, documentation, and
- this README
-```
-To create a disribution on linux (or mac?)
-- `make dist`
+# Building the Package
+## Linux / Mac using make and xelatex
+1. `make`
+
+## Otherwise
+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).
# Installation
-For linux, run `make` to generate the package (.sty file) and documentation.
-If you are using texlive (most modern linux distributions use texlive), you may
-then run `sudo make localinstall` to install the package to your latex
-distribution. If you are not using texlive, you will need to manually
-copy the .sty file into either the folder where your .tex files reside that
-require the package, or manually install the package in your latex distribution.
+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.
+
+## 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).
+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.
+1. Figure out where your LaTeX local package documentation is installed.
+1. Create a directory named `physconst` in that location.
+1. Copy the `.pdf` file into the directory you just created.
+1. Run `texhash` or the equivalent to let LaTeX know the package is there.
-For mac, the instructions above for linux might work. Otherwise you're sort of
-on your own. Most likely your latex disrubution is somewhere in /usr/share.
-You will need to figure out the name and where the package files are stored,
-then run `texhash` so that latex knows that they are there.
-For windows, you're kind of on your own. Instructions that might help can be
-found at [this post on StackExchange](https://tex.stackexchange.com/questions/369921/loading-packages-with-ins-and-dtx-files).
+# Uninstallation
+### Linux / Mac using make
+1. `make localuninstall`
+### Otherwise
+1. Figure out where your LaTeX local packages are installed.
+1. Delete the directory named `physconst` in that location.
+1. Figure out where your LaTeX local package documentation is installed.
+1. Delete the directory named `physconst` in that location.
+1. Run `texhash` or the equivalent to let LaTeX know the package is gone.