Use 'inline code' format for commands in README.md
authorIvan Maidanski <ivmai@mail.ru>
Thu, 18 May 2017 08:13:24 +0000 (11:13 +0300)
committerIvan Maidanski <ivmai@mail.ru>
Thu, 18 May 2017 08:13:24 +0000 (11:13 +0300)
* README.md: Quote commands with a grave accent character ("`"); the
same for names containing an underscore; reformat text.

README.md

index 84dd4d7..cd47526 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# The atomic_ops library (libatomic_ops)
+# The atomic_ops library (`libatomic_ops`)
 
 IN NEW CODE, PLEASE USE C11 OR C++14 STANDARD ATOMICS INSTEAD OF THIS PACKAGE.
 
@@ -45,30 +45,31 @@ Please address bug reports to [mailing list](mailto:bdwgc@lists.opendylan.org).
 ## Installation and Usage
 
 The configuration and build scripts for this package were generated by
-Automake/Autoconf.  "./configure; make; sudo make install" in this
+Automake/Autoconf.  `./configure; make; sudo make install` in this
 directory should work.  For a more customized build, see the output of
-"./configure --help".  To build it from the development repository,
-"./autogen.sh" should be executed first.
+`./configure --help`.  To build it from the development repository,
+`./autogen.sh` should be executed first.
 
 Note that much of the content of this library is in the header files.
 However, two small libraries are built and installed:
 
-* libatomic_ops.a is a support library, which is not needed on some platforms.
-  This is intended to be usable, under some mild restrictions, in free or
-  proprietary code, as are all the header files.  See doc/LICENSING.txt.
+* `libatomic_ops.a` is a support library, which is not needed on some
+  platforms. This is intended to be usable, under some mild restrictions,
+  in free or proprietary code, as are all the header files.
+  See doc/LICENSING.txt.
 
-* libatomic_ops_gpl.a contains some higher level facilities.  This code is
+* `libatomic_ops_gpl.a` contains some higher level facilities.  This code is
   currently covered by the GPL.  The contents currently correspond to
-  the headers atomic_ops_stack.h and atomic_ops_malloc.h.
+  the headers `atomic_ops_stack.h` and `atomic_ops_malloc.h`.
 
 
 ## Platform Specific Notes
 
 Win32/64: src/Makefile.msft contains a very simple Makefile for building
-and running tests and building the gpl library.  The core atomic_ops
+and running tests and building the gpl library.  The core `libatomic_ops`
 implementation is entirely in header files.
 
-HP-UX/PA-RISC: aCC -Ae won't work as a C compiler, since it doesn't support
+HP-UX/PA-RISC: `aCC -Ae` won't work as a C compiler, since it doesn't support
 inline assembly code.  Use cc.