diff options
| author | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-09-04 22:27:54 +0200 |
|---|---|---|
| committer | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-09-10 17:30:22 +0200 |
| commit | f20aafeec01f27c573dcf76c87b3e9228c5a8dd0 (patch) | |
| tree | a2c9457e2d0df66b2073ddaffce6b3e03caf5dc3 /README.md | |
| parent | frr: remove stale files, allow non-GNU Automake (diff) | |
| download | frr-f20aafeec01f27c573dcf76c87b3e9228c5a8dd0.tar.xz frr-f20aafeec01f27c573dcf76c87b3e9228c5a8dd0.zip | |
frr: improve README
Friendly READMEs are all the rage!
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..48142f21b --- /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 +``` |