diff --git a/docs/index.rst b/docs/index.rst index f8f2617..ef0fcd0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,8 @@ Welcome to Birdvisu's documentation! :maxdepth: 2 :caption: Contents: + intro + Indices and tables diff --git a/docs/intro.rst b/docs/intro.rst new file mode 100644 index 0000000..e2d76f7 --- /dev/null +++ b/docs/intro.rst @@ -0,0 +1,9 @@ +Introduction +@@@@@@@@@@@@ + +Birdvisu is a library and a graphical app to visualize routing topologies of +OSPF. It does not implement OSPF on its own, but rather exports current state +from `BIRD`_ – that's where the name comes from. + + +.. _BIRD: https://bird.network.cz