diff mbox series

Convert README to README.md

Message ID 20200423132833.211294-1-plautrba@redhat.com (mailing list archive)
State Superseded
Headers show
Series Convert README to README.md | expand

Commit Message

Petr Lautrbach April 23, 2020, 1:28 p.m. UTC 
It should make the document readable for github users.

Fixes: https://github.com/SELinuxProject/selinux/issues/225

Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
---
 README    | 25 -------------------------
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 25 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

Comments

Paul Moore April 23, 2020, 1:48 p.m. UTC | #1 
On Thu, Apr 23, 2020 at 9:29 AM Petr Lautrbach <plautrba@redhat.com> wrote:
>
> It should make the document readable for github users.
>
> Fixes: https://github.com/SELinuxProject/selinux/issues/225
>
> Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
> ---
>  README    | 25 -------------------------
>  README.md | 41 +++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 41 insertions(+), 25 deletions(-)
>  delete mode 100644 README
>  create mode 100644 README.md

...

> --- /dev/null
> +++ b/README.md
> @@ -0,0 +1,41 @@
> +SELinux Userspace
> +=================
> +
> +Please submit all bug reports and patches to <selinux@vger.kernel.org>.
> +
> +Subscribe by sending "subscribe selinux" in the body of an email
> +to <majordomo@vger.kernel.org>.
> +
> +Installation
> +------------
> +
> +Build dependencies on Fedora:
> +
> +       yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config

Other than the different amount of white space on the line above
compared to the other command examples, it looks good to me - thanks
Petr.

> +
> +
> +To build and install everything under a private directory, run:
> +
> +    make DESTDIR=~/obj install install-pywrap
> +
> +To install as the default system libraries and binaries
> +(overwriting any previously installed ones - dangerous!),
> +on x86_64, run:
> +
> +    make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
> +
> +or on x86 (32-bit), run:
> +
> +    make install install-pywrap relabel
> +
> +This may render your system unusable if the upstream SELinux userspace
> +lacks library functions or other dependencies relied upon by your
> +distribution.  If it breaks, you get to keep both pieces.
> +
> +To install libsepol on macOS (mainly for policy analysis):
> +
> +    cd libsepol; make PREFIX=/usr/local install
> +
> +This requires GNU coreutils:
> +
> +    brew install coreutils
> --
> 2.26.0
>
diff mbox series

Patch

diff --git a/README b/README
deleted file mode 100644
index e4423ca23b58..000000000000
--- a/README
+++ /dev/null
@@ -1,25 +0,0 @@ 
-Please submit all bug reports and patches to selinux@vger.kernel.org.
-Subscribe by sending "subscribe selinux" in the body of an email
-to majordomo@vger.kernel.org.
-
-Build dependencies on Fedora:
-yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
-
-To build and install everything under a private directory, run:
-make DESTDIR=~/obj install install-pywrap
-
-To install as the default system libraries and binaries
-(overwriting any previously installed ones - dangerous!),
-on x86_64, run:
-make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
-or on x86 (32-bit), run:
-make install install-pywrap relabel
-
-This may render your system unusable if the upstream SELinux userspace
-lacks library functions or other dependencies relied upon by your
-distribution.  If it breaks, you get to keep both pieces.
-
-To install libsepol on macOS (mainly for policy analysis):
-cd libsepol; make PREFIX=/usr/local install
-
-This requires GNU coreutils (brew install coreutils).
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..b05f1c74f279
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@ 
+SELinux Userspace
+=================
+
+Please submit all bug reports and patches to <selinux@vger.kernel.org>.
+
+Subscribe by sending "subscribe selinux" in the body of an email
+to <majordomo@vger.kernel.org>.
+
+Installation
+------------
+
+Build dependencies on Fedora:
+    
+	yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
+
+
+To build and install everything under a private directory, run:
+
+    make DESTDIR=~/obj install install-pywrap
+
+To install as the default system libraries and binaries
+(overwriting any previously installed ones - dangerous!),
+on x86_64, run:
+
+    make LIBDIR=/usr/lib64 SHLIBDIR=/lib64 install install-pywrap relabel
+
+or on x86 (32-bit), run:
+
+    make install install-pywrap relabel
+
+This may render your system unusable if the upstream SELinux userspace
+lacks library functions or other dependencies relied upon by your
+distribution.  If it breaks, you get to keep both pieces.
+
+To install libsepol on macOS (mainly for policy analysis):
+
+    cd libsepol; make PREFIX=/usr/local install
+
+This requires GNU coreutils:
+
+    brew install coreutils