diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..600a91e --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +<p align="center"> +<img src="http://docs.frrouting.org/en/latest/_static/frr-icon.svg" alt="Icon" width="20%"/> +</p> + +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 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 +* PBR +* OpenFabric +* VRRP +* EIGRP (alpha) +* NHRP (alpha) + +Installation & Use +------------------ + +For source tarballs, see the +[releases page](https://github.com/FRRouting/frr/releases). + +For Debian and its derivatives, use the APT repository at +[https://deb.frrouting.org/](https://deb.frrouting.org/). + +Instructions on building and installing from source for supported platforms may +be found in the +[developer docs](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). You can join +by clicking the "Slack" link under the +[Participate](https://frrouting.org/community) section of our website. + + +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 +``` |