aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Peter McGoron 2022-04-02 20:36:51 -0400
committerGravatar Peter McGoron 2022-04-02 20:36:51 -0400
commit5a580c68fd19a74fabe62b47d14d9e8f949d994a (patch)
treed66fff36650d47e7d8edfc20a0f8edecb96e901f /README.md
add man pages
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4c4f5f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+Scientific Reference Man Pages
+==============================
+
+Note: These manpages use Unicode extensively and are written for
+[mandoc](https://mandoc.bsd.lv/).
+
+elements.7
+----------
+
+The periodic table of the elements, rotated 90 degrees to fit into a
+standard width terminal.
+
+constants.7
+-----------
+
+The [CODATA Values of the Fundamental Physical Constants][1].
+
+[1]: https://physics.nist.gov/cuu/Constants/index.html
+
+si.7
+----
+
+A reference for the SI units. Includes
+
+* Values of prefixes
+* All base and derived units with names from the SI brochure
+* All accepted non-SI units
+* Conversions between some non-SI units and SI equivalents
+
+How to Install
+==============
+
+Place into your system's manual page directory (on most systems, this
+will be `/usr/local/share/man/man7`), and run `makewhatis` as root.