aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPhilip Kaludercic <philipk@posteo.net>2022-02-05 17:13:35 +0100
committerPhilip Kaludercic <philipk@posteo.net>2022-02-05 17:13:35 +0100
commit503b13f1b18fb1e4f3bdb66b6363dc44fd0a2ee2 (patch)
treebb01ca867e44cc9de98638f26cbdb2b671da69bc /README.md
parent0125f90e64acdde9d3d4508a779e7b7d5f83be62 (diff)
Add compat-help as an infrastructure to manage relevant notes
This is a voluntary library a developer might load to have notes inserted into help buffers of functions that might differ from their intuitive or expected behaviour.
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 62042b6..ccf80ad 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,11 @@ Version 24.3 is chosen as the oldest version, because this is the
newest version on CentOS 7. It is intended to preserve compatibility
for at least as the Centos 7 reaches [EOL], 2024.
+If you are developing a package with compat.el in mind, consider
+loading `compat-help` (on your system, not in a package) to get
+relevant notes inserted into the help buffers of functions that are
+implemented or advised in compat.el.
+
Installation
------------