Skip to content

Commit

Permalink
Rename README to README.md (rtrlib#253)
Browse files Browse the repository at this point in the history
* Rename README to README.md

* Cleanup Formatting of README.md
  • Loading branch information
jakobod authored and waehlisch committed Oct 30, 2019
1 parent 4828e6c commit 09b5c49
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ indent_size = 4
[{.travis.yml,CMakeLists.txt}]
indent_style = space
indent_size = 4

[*.md]
indent_style = space
indent_size = 2
max_line_width = 72
29 changes: 13 additions & 16 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
Introduction
------------
The RTRlib implements the client-side of the RPKI-RTR protocol (RFC
6810, RFC 8210) and BGP Prefix Origin Validation (RFC 6811). This also
enables the maintenance of router keys. Router keys are required to
deploy BGPSEC.
The RTRlib implements the client-side of the RPKI-RTR protocol
([RFC 6810](https://tools.ietf.org/html/rfc6810)),
([RFC 8210](https://tools.ietf.org/html/rfc8210)) and BGP Prefix Origin
Validation ([RFC 6811](https://tools.ietf.org/html/rfc6811)). This also enables
the maintenance of router keys. Router keys are required to deploy BGPSEC.

The software was successfully tested on Linux and FreeBSD.

This package contains also the rtrclient program. It connects to an
This package contains also the `rtrclient` program. It connects to an
RTR-Server over TCP or SSH and shows on STDOUT prefix origin data and
router keys that have been received from the RTR server. The program can
be found in the bin/ directory.
Expand All @@ -30,11 +31,11 @@ Compilation

Without debugging options

cmake -D CMAKE_BUILD_TYPE=Release .
cmake -D CMAKE_BUILD_TYPE=Release .

With debug symbols and debug messages:

cmake -D CMAKE_BUILD_TYPE=Debug .
cmake -D CMAKE_BUILD_TYPE=Debug .

If the libssh isn't installed within the systems include and library
directories you can run cmake with the following parameters:
Expand All @@ -58,7 +59,7 @@ Compilation

* Build library, tests, and tools

make
make


Installation
Expand All @@ -85,6 +86,7 @@ occurs, the location of the library can be passed explicitly as a parameter
-L<path_to_librtr.so>

e.g.,

-L/usr/local/lib64/


Expand All @@ -104,7 +106,7 @@ RTR-Server using the rtrclient command line tool:

bin/rtrclient tcp rpki-validator.realmv6.org 8282

rpki-validator.realmv6.org is an open RTR-Server instance for testing
`rpki-validator.realmv6.org` is an open RTR-Server instance for testing
purposes, which runs the RIPE Validator. It listens on port 8282 and
validates ROAs from the following trust anchors: AfriNIC, APNIC, ARIN,
LACNIC, RIPE.
Expand All @@ -122,12 +124,7 @@ Directories

Contact
-------
Website: http://rtrlib.realmv6.org/

Mailing List: [email protected]



Website: [http://rtrlib.realmv6.org/](http://rtrlib.realmv6.org/)

Mailing List: [[email protected]](mailto:[email protected])

/* vim: set tw=72 sts=2 sw=2 ts=2 expandtab: */

0 comments on commit 09b5c49

Please sign in to comment.