[gfs2-utils] 03/04: Convert README to markdown

This is an automated email from the git hooks/post-receive script.

andyp pushed a commit to branch master
in repository gfs2-utils.

commit e6c895925c91b0c793e7da72afbea0b855cfd962
Author: Andrew Price <anprice(a)redhat.com&gt;
AuthorDate: Tue Sep 1 12:13:14 2020 +0100

    Convert README to markdown
    
    Signed-off-by: Andrew Price <anprice(a)redhat.com&gt;
---
 Makefile.am |  2 +-
 README      | 71 -----------------------------------------------------
 README.md   | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 82 insertions(+), 72 deletions(-)

diff --git a/Makefile.am b/Makefile.am
index adeb56d..f04c1d3 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-EXTRA_DIST = autogen.sh README
+EXTRA_DIST = autogen.sh README.md
 
 AUTOMAKE_OPTIONS = foreign
 
diff --git a/README b/README
deleted file mode 100644
index a04653f..0000000
--- a/README
+++ /dev/null
@@ -1,71 +0,0 @@
-gfs2-utils
-----------
-
-This package contains the tools needed to create, check, manipulate and analyze
-gfs2 filesystems, along with important scripts required to support gfs2
-clusters.
-
-Build instructions
-------------------
-
-The following development packages are required to build gfs2-utils:
-
- o autoconf
- o automake
- o libtool
- o GNU make
- o ncurses
- o gettext
- o bison
- o flex
- o zlib
- o libblkid
- o libuuid
- o check (optional, enables unit tests)
-
-The kernel header include/linux/gfs2-ondisk.h and its dependencies are also
-required.
-
-To build gfs2-utils, run the following commands:
-
- $ ./autogen.sh
- $ ./configure
- $ make
-
-See ./configure --help for more build configuration options.
-
-Test Suite
-----------
-
-To run the test suite, use:
-
- $ make check
-
-See doc/README.tests for more details regarding the test suite.
-
-Installation
-------------
-
-gfs2-utils requires the following libraries:
-
- o zlib
- o ncurses
- o libblkid
- o libuuid
-
-To install gfs2-utils, run:
-
- # make install
-
-Support scripts
----------------
-
-The following scripts (located in gfs2/scripts) are used to complete
-the userland portion of the gfs2 withdraw feature using uevents. They
-will be installed by 'make install' to these directories by default:
-
-  82-gfs2-withdraw.rules in /usr/lib/udev/rules.d/
-  gfs2_withdraw_helper   in /usr/sbin/
-
-See also doc/README.contributing for details on submitting patches.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..499934e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+# gfs2-utils
+
+This package contains the tools needed to create, check, manipulate and analyze
+gfs2 filesystems, along with important scripts required to support gfs2
+clusters.
+
+## Build instructions
+
+### Prerequisites
+
+The following development packages are required to build gfs2-utils:
+
+* autoconf
+* automake
+* libtool
+* GNU make
+* ncurses
+* gettext
+* bison
+* flex
+* zlib
+* bzip2
+* libblkid
+* libuuid
+* check (optional, enables unit tests)
+
+The kernel header `include/linux/gfs2-ondisk.h` and its dependencies are also
+required.
+
+### How to build
+
+To build gfs2-utils, run the following commands:
+
+```
+$ ./autogen.sh
+$ ./configure
+$ make
+```
+
+See `./configure --help` for more build configuration options.
+
+## Test suite
+
+To run the test suite, use:
+
+```
+$ make check
+```
+
+See [doc/README.tests](doc/README.tests) for more details regarding the test suite.
+
+## Installation
+
+gfs2-utils requires the following libraries:
+
+* zlib
+* bzip2
+* ncurses
+* libblkid
+* libuuid
+
+To install gfs2-utils, run:
+
+```
+# make install
+```
+
+## Support scripts
+
+The following scripts (located in [gfs2/scripts/](gfs2/scripts)) are used to
+complete the userland portion of the gfs2 withdraw feature using uevents. They
+will be installed by `make install` to these directories by default:
+
+Script                 | Default install path
+---------------------- | ----------------------
+82-gfs2-withdraw.rules | /usr/lib/udev/rules.d/
+gfs2_withdraw_helper   | /usr/libexec/
+
+See also [doc/README.contributing](doc/README.contributing) for details on
+submitting patches.
+

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.