From d5b75915f6f9e9ba990e319a39a3a5e647654db3 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Fri, 11 Nov 2022 14:48:41 -0500 Subject: [PATCH] README: various prose improvements. --- README | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/README b/README index db37f24..a5ec6e5 100644 --- a/README +++ b/README @@ -1,20 +1,14 @@ -1. What +== What this is == -Nagios-mode is an Emacs mode for editing Nagios[1] configuration -files. You probably already know that, or you wouldn't be reading -this. But maybe you just love Emacs, and you go around looking for -things that end in -mode. Then you README them. +Nagios-mode is an Emacs mode for editing Nagios configuration +files. Nagios is monitoring software that is configured via plain-text +(*.cfg) files. Those configuration files have a C-like syntax, and a +bunch of special keywords. Witin Emacs, nagios-mode will apply syntax +highlighting to them, possibly alerting you to the fact that you have +done something wrong, and making your buffers look pretty in any case. -So, Nagios is monitoring software that is configured via plain-text -(*.cfg) files. They have a C-like syntax, and a bunch of special -keywords. Nagios mode will apply syntax highlighting to these -configuration files, possibly alerting you to the fact that you have -done something stupid. Moreover, the buffers will look prettier. -[1] http://www.nagios.org/ - - -2. Where +== How to install it == Stick nagios-mode.el somewhere, and add that place to your Emacs load path. For example, @@ -34,11 +28,11 @@ And tell Emacs to use it automatically when editing *.cfg files, (append (list '("\\.cfg$" . nagios-mode)) auto-mode-alist)) -which is great as long as you don't have other *.cfg files with a -different syntax. That case is left as an exercise for the reader. +which works great so long as you don't work with any other *.cfg files +that have a different syntax. -3. How +== How it works == The macros and object definitions are parsed from the Nagios source code. Object definitions are found within xdata/xodtemplate.h, while @@ -52,7 +46,7 @@ variables isn't highlighted. Then I add it. You can mail me these and I will probably add them. -4. When +== Bugs et cetera == -No seriously, I'm running out of words to use as headings. Send bug -reports and feature requests to michael@orlitzky.com. +Send all bug reports, feature requests, and unprompted criticism to +michael@orlitzky.com. -- 2.44.2