Skip to content

Latest commit

 

History

History
95 lines (77 loc) · 3.45 KB

README.dist.md

File metadata and controls

95 lines (77 loc) · 3.45 KB
Raw

physconst

A LaTeX package that includes macros for a variety of fundamental constants.

License

Copyright (C) 2020 by Brian W. Mulligan bwmulligan@astronaos.com

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

Build Dependencies

  • some LaTeX distribution.
  • hyperref package for LaTeX
  • xcolor package for LaTeX
  • mdframed package for LaTeX
  • imakeidx package for LaTeX

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
    physconst.dtx           The package code and documentation
    physconst.pdf           The package user manual

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.
  2. The following steps apply only if you want the documentation (recommended).
  3. Run latex on physconst.dtx to create the .pdf file. e.g. xelatex physconst.pdf.
  4. Run makeindex to create the index, e.g. makeindex -s gind.ist -o physconst.ind physconst.idx.
  5. Run makeindex to create the change log, e.g. makeindex -s gglo.ist -o physconst.gls physconst.glo.
  6. Run latex on physconst.dtx to create the .pdf file with index and change log. e.g. xelatex physconst.pdf.
  7. 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.

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.

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.

  1. Figure out where your LaTeX local packages are installed.
  2. Create a directory named physconst in that location.
  3. Copy the .sty file into the directory you just created.
  4. Figure out where your LaTeX local package documentation is installed.
  5. Create a directory named physconst in that location.
  6. Copy the .pdf file into the directory you just created.
  7. 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.
  2. Delete the directory named physconst in that location.
  3. Figure out where your LaTeX local package documentation is installed.
  4. Delete the directory named physconst in that location.
  5. Run texhash or the equivalent to let LaTeX know the package is gone.