summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/smartunits/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/smartunits/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/smartunits/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/smartunits/README.md b/Master/texmf-dist/doc/latex/smartunits/README.md
new file mode 100644
index 00000000000..1942639f661
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/smartunits/README.md
@@ -0,0 +1,53 @@
+smartunits
+==========
+
+A [LaTeX](http://en.wikipedia.org/wiki/LaTeX) package that implements
+automatic conversions between (some) metric and Imperial units.
+
+Example
+-------
+
+```tex
+\documentclass{article}
+\usepackage{smartunits}
+\begin{document}
+ \SmartUnitSettings{metric imperial, places=1}
+ \SmartUnit{cm=10} % 10 cm (4')
+ \SmartUnit{celsius=20} % 20 C (43 F)
+ \SmartUnit{miles=5} % 8 km (5 mi)
+ \SmartUnit{miles=5, precision=1} % 8.0 km (5 mi)
+ \SmartUnit{miles=5, km=7} % 7 km (5 mi)
+\end{document}
+```
+
+Units supported
+---------------
+
+Currently smartunits converts between the following five classes of units:
+
+ ============ ==============
+ Metric Imperial
+ ------------ -------------- -------------
+ kilometers miles (distance)
+ centimeters feet and inches (length)
+ Celsius Fahrenheit (temperature)
+ 24-hour time 12-hour time (time)
+ litres USA/UK gallons (volume)
+ kilograms pounds (weight)
+ ============ ============== =============
+
+It is quite easy to extend the code to other units. I am happy to consider new requests.
+
+Requirements
+------------
+
+The package requires
+[pgfkeys](https://www.ctan.org/pkg/pgfkeys) and
+[siunitx](https://www.ctan.org/pkg/siunitx).
+
+### Author
+
+Copyright (c) 2016 [Andrew Mathas](mailto:andrew.mathas@gmail.com)
+
+Released under the [LaTeX Project Public
+License](http://www.latex-project.org/lppl.txt) v1.3c or later