diff options
author | Norbert Preining <norbert@preining.info> | 2023-11-24 03:00:51 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2023-11-24 03:00:51 +0000 |
commit | ac5a5e57a4c9b3c436c3bac327fe885acea28ba4 (patch) | |
tree | 52e2cdef50f95b55a5cec2f48cc27bfef4ce1a39 /macros/latex/contrib/mandi/README.md | |
parent | 4b11f001033c31cf22cda6f3d77dc2b5f013cd5b (diff) |
CTAN sync 202311240300
Diffstat (limited to 'macros/latex/contrib/mandi/README.md')
-rw-r--r-- | macros/latex/contrib/mandi/README.md | 39 |
1 files changed, 32 insertions, 7 deletions
diff --git a/macros/latex/contrib/mandi/README.md b/macros/latex/contrib/mandi/README.md index bc2d56ec0a..08370223e0 100644 --- a/macros/latex/contrib/mandi/README.md +++ b/macros/latex/contrib/mandi/README.md @@ -1,9 +1,34 @@ -`mandi` provides commands for introductory physics. To install, open a command -line and type the following, repeating 2-4 until there are no warnings: +# mandi - Macros for introductory physics - 1. `lualatex mandi.ins` (can also use latex) - 2. `lualatex mandi.dtx` (lualatex is required) - 3. `makeindex -s gind.ist -o mandi.ind mandi.idx` - 4. `makeindex -s gglo.ist -o mandi.gls mandi.glo` +## Description +`mandi` (which can be pronounced with two syllables rhyming with _candy_, or with three +as _M and I_, referencing a popular introductory physics textbook) is for students and +instructors in an introductory physics course. They can use `mandi` to write solutions, +class notes, handouts, assessments, and other such documents. Using physical quantities +(and constants) by name eliminates missing units. Step-by-step solutions and reasoning +eliminates missing work, and consistent notation can be employed. -Move the `*.sty` files into a directory searched by TeX. Delete `vdemo.py`. +### `mandi` +The `mandi` package defines every physical quantity and constant used in introductory +physics by its name. SI units are included by default in any of three different kinds +(base, derived, and alternate). A simple interface for defining additional quantities +and constants is provided. + +### `mandistudent` +The `mandistudent` package defines additional commands and environments for writing +solutions to physics problems. The `physicsproblem` and `physicssolution` environments +allow for semantically structured solutions. Computational problems are accommodated +as [Web VPython](https://glowscript.org/) and [VPython](https://vpython.org/) code. + +### `mandiexp` +The `mandiexp` package defines commands for typesetting the equations and expressions +most frequently used in introductory physics. The equations and expressions are based +on those found in [*Matter & Interactions*](https://matterandinteractions.org/) but +are certainly applicable to any introductory physics textbook. + +## Author and Maintainer +`mandi` is authored and maintained by +[Paul J. Heafner](mailto:heafnerj@gmail.com?subject=[Heafner]%20mandi). + +## License +`mandi` is released under [LPPL](https://www.latex-project.org/lppl.txt) 1.3c and later. |