frr: improve README

Friendly READMEs are all the rage!

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

diff --git a/README b/README
deleted file mode 100644 (file)
index 7600ec5..0000000
--- a/README
+++ /dev/null
@@ -1,16 +0,0 @@
-FRRouting is free software that implements and manages various IPv4 and IPv6
-routing protocols.
-
-Currently FRRouting supports BGP4, BGP4+, OSPFv2, OSPFv3, RIPv1, RIPv2, RIPng,
-IS-IS, PIM-SM/MSDP, LDP and Babel as well as very early support for EIGRP and
-NHRP.
-
-See doc/user/bugs.rst for information on how to report bugs.
-
-See doc/developer/workflow.rst for information on contributing.
-
-See the file COPYING for copying conditions.
-
-Public email discussion can be found at https://lists.frrouting.org/listinfo
-
-Our public slack channel is at https://frrouting.slack.com

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..48142f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+FRRouting
+=========
+
+FRR is free software that implements and manages various IPv4 and IPv6 routing
+protocols. It runs on nearly all distributions of Linux and BSD as well as
+Solaris and supports all modern CPU architectures.
+
+FRR currently supports the following protocols:
+
+* BGP
+* OSPFv2
+* OSPFv3
+* RIPv1
+* RIPv2
+* RIPng
+* IS-IS
+* PIM-SM/MSDP
+* LDP
+* BFD
+* Babel
+* EIGRP (alpha)
+* NHRP (alpha)
+
+Installation & Use
+------------------
+
+Packages are available for various distributions on our
+[releases page](https://github.com/FRRouting/frr/releases).
+
+Snaps are also available [here](https://snapcraft.io/frr).
+
+Instructions on building and installing from source for supported platforms may
+be found
+[here](http://docs.frrouting.org/projects/dev-guide/en/latest/building.html).
+
+Once installed, please refer to the [user guide](http://docs.frrouting.org/)
+for instructions on use.
+
+Community
+---------
+
+The FRRouting email list server is located
+[here](https://lists.frrouting.org/listinfo) and offers the following public
+lists:
+
+| Topic             | List                         |
+|-------------------|------------------------------|
+| Development       | dev@lists.frrouting.org      |
+| Users & Operators | frog@lists.frrouting.org     |
+| Announcements     | announce@lists.frrouting.org |
+
+For chat, we currently use [Slack](https://frrouting.slack.com). Please email
+the mailing list to request an invite as we do not issue automatic invites.
+
+
+Contributing
+------------
+
+FRR maintains [developer's documentation](http://docs.frrouting.org/projects/dev-guide/en/latest/index.html)
+which contains the [project workflow](http://docs.frrouting.org/projects/dev-guide/en/latest/workflow.html)
+and expectations for contributors. Some technical documentation on project
+internals is also available.
+
+We welcome and appreciate all contributions, no matter how small!
+
+
+Security
+--------
+
+To report security issues, please use our security mailing list:
+
+```
+security [at] lists.frrouting.org
+```

diff --git a/configure.ac b/configure.ac
index 9378f1f23bc80c8d8fb1cdcba123b8c98e224009..08f1c117ec83092b099cf0508ab71a5be72d0252 100755 (executable)
--- a/configure.ac
+++ b/configure.ac
@@ -57,7 +57,7 @@ AM_CONDITIONAL([BUILD_CLIPPY], [$build_clippy])
 
 # Disable portability warnings -- our automake code (in particular
 # common.am) uses some constructs specific to gmake.
-AM_INIT_AUTOMAKE([1.12 -Wno-portability], [foreign])
+AM_INIT_AUTOMAKE([1.12 -Wno-portability foreign])
 m4_ifndef([AM_SILENT_RULES], [m4_define([AM_SILENT_RULES],[])])
 AM_SILENT_RULES([yes])
 AC_CONFIG_HEADERS(config.h)

diff --git a/debianpkg/frr-doc.docs b/debianpkg/frr-doc.docs
index d4043d9ea8a13ad055b10df41e14e716ff7270c4..605353289c178e0dd3df54571f91728430eaf42d 100644 (file)
--- a/debianpkg/frr-doc.docs
+++ b/debianpkg/frr-doc.docs
@@ -1,3 +1,3 @@
-README
+README.md
 doc/user/*.rst
 doc/figures/*.png

diff --git a/redhat/frr.spec.in b/redhat/frr.spec.in
index 8e9d376b675ec36e3d7abf79ff7260b104967598..bff0b405151344571be6a87080cb0bf9e4b6113d 100644 (file)
--- a/redhat/frr.spec.in
+++ b/redhat/frr.spec.in
@@ -563,7 +563,7 @@ fi
 %files
 %doc */*.sample* COPYING
 %doc doc/mpls
-%doc README
+%doc README.md
 %if 0%{?frr_user:1}
     %dir %attr(751,%{frr_user},%{frr_user}) %{configdir}
     %dir %attr(750,%{frr_user},%{frr_user}) %{_localstatedir}/log/frr