summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/physconst
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-01-26 22:20:21 +0000
committerKarl Berry <karl@freefriends.org>2020-01-26 22:20:21 +0000
commitcb12e9ff3c8ba280dca547d4b5e80629d28b4e09 (patch)
tree10e2e32502c1c894556012b4ca83f6cda83db533 /Master/texmf-dist/doc/latex/physconst
parent9fc6341d273edf6d5788c3a0a404a0fed4bdc058 (diff)
physconst (26jan20)
git-svn-id: svn://tug.org/texlive/trunk@53551 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/physconst')
-rw-r--r--Master/texmf-dist/doc/latex/physconst/CHANGELOG.md27
-rw-r--r--Master/texmf-dist/doc/latex/physconst/README.md72
-rw-r--r--Master/texmf-dist/doc/latex/physconst/physconst.pdfbin0 -> 135381 bytes
3 files changed, 99 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/physconst/CHANGELOG.md b/Master/texmf-dist/doc/latex/physconst/CHANGELOG.md
new file mode 100644
index 00000000000..964bf35aa66
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physconst/CHANGELOG.md
@@ -0,0 +1,27 @@
+# Changes
+## [1.0.0] - 2020/01/25
+- Initial version
+## [1.0.1] - 2020/01/25
+### Added
+- A changelog
+- A readme
+- Code for changelog into physconst.cpp
+- `make dist` to create distributable tarball and zip
+- Documentation for options
+- line in .ins to force generation of the .sty
+- nicer index entries (and some associated code in .cpp to generate them)
+- added localuninstall and distuninstall targets to the makefile
+### Changed
+- Modified the makefile to split up generation of the .sty, .dtx, and .pdf
+- Modified the .cpp so that every \DeclareRobustCommand starts a new line right away
+- Added a newline in the middle of the title declaration (in .cpp)
+- Added a newline in the middle of the \DoNotIndex declaration (in .cpp)
+- Added dependency on imakeidx and changed the index to 2 column.
+- fixed makefile install options to correctly find TEXMF path
+### Removed
+- Removed unnecessary packages (tikz, float) from the code for the documentation
+## [1.0.2] - 2020/01/25
+### Changed
+- Switch compression of tarball to gzip to match requirement for CTAN
+
+
diff --git a/Master/texmf-dist/doc/latex/physconst/README.md b/Master/texmf-dist/doc/latex/physconst/README.md
new file mode 100644
index 00000000000..67dd9a8073c
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physconst/README.md
@@ -0,0 +1,72 @@
+# 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
+- [`physunits` package](https://github.com/astrobit/physunits)
+
+# 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
+- `hyperref` package for LaTeX
+- `xcolor` package for LaTeX
+- `mdframed` package for LaTeX
+- `imakeidx` package for LaTeX
+- GNU `make`
+
+# Files
+```
+ 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
+```
+
+# 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`
+
+# 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.
+
+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).
+
+
diff --git a/Master/texmf-dist/doc/latex/physconst/physconst.pdf b/Master/texmf-dist/doc/latex/physconst/physconst.pdf
new file mode 100644
index 00000000000..b8949005283
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/physconst/physconst.pdf
Binary files differ