From c1881c5c5344914a46d0f06387afcb78981a85c5 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 27 Jan 2020 21:56:05 +0000 Subject: physunits (27jan20) git-svn-id: svn://tug.org/texlive/trunk@53574 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/physunits/README.md | 81 +++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 Master/texmf-dist/doc/latex/physunits/README.md (limited to 'Master/texmf-dist/doc/latex/physunits/README.md') diff --git a/Master/texmf-dist/doc/latex/physunits/README.md b/Master/texmf-dist/doc/latex/physunits/README.md new file mode 100644 index 00000000000..ce400e3487e --- /dev/null +++ b/Master/texmf-dist/doc/latex/physunits/README.md @@ -0,0 +1,81 @@ +# physunits +A LaTeX package that includes macros for SI, cgs, and some imperial units. + +# License +Copyright (C) 2020 by Brian W. Mulligan +----------------------------------------------------------- + +This file may be distributed and/or modified under the conditions of +the LaTeX Project Public License, either version 1.3c of this license +or (at your option) any later version. The latest version of this +license is in: + +http://www.latex-project.org/lppl.txt + +and version 1.3c or later is part of all distributions of LaTeX +version 2006/05/20 or later. + +# Dependencies +None. + +# Build Dependencies +- some LaTeX distribution. +- `hyperref` package for LaTeX + +# Files +``` + makefile GNU makefile to simplify building and installation on linux + README.md This file. + CHANGELOG.md List of changes + physunits.ins The installer file + physunits.dtx The package code and documentation + physunits.pdf The package user manual +``` + +# Building the Package +## Linux / Mac using make and xelatex +1. `make` + +## Otherwise +1. Run `latex` on `physunits.ins` to create the `.sty` file. e.g. `latex physunits.ins`. +1. The following steps apply only if you want the documentation (recommended). + 1. Run `latex` on `physunits.dtx` to create the `.pdf` file. e.g. `xelatex physunits.pdf`. + 1. Run `makeindex` to create the index, e.g. `makeindex -s gind.ist -o physunits.ind physunits.idx`. + 1. Run `makeindex` to create the change log, e.g. `makeindex -s gglo.ist -o physunits.gls physunits.glo`. + 1. Run `latex` on `physunits.dtx` to create the `.pdf` file with index and change log. e.g. `xelatex physunits.pdf`. + 1. Run `latex` on `physunits.dtx` to get the labels sorted out. e.g. `xelatex physunits.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 `physunits.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 `physunits` 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 `physunits` 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. + + +# Uninstallation + +### Linux / Mac using make +1. `make localuninstall` +### Otherwise +1. Figure out where your LaTeX local packages are installed. +1. Delete the directory named `physunits` in that location. +1. Figure out where your LaTeX local package documentation is installed. +1. Delete the directory named `physunits` in that location. +1. Run `texhash` or the equivalent to let LaTeX know the package is gone. + -- cgit v1.2.3