From 62ffcd426eb749c290250fc4278e5d2bb33a36f8 Mon Sep 17 00:00:00 2001 From: Christian Giese Date: Fri, 5 Feb 2021 21:46:21 +0100 Subject: [PATCH] Update Docs --- docs/_config.yml | 1 - docs/index.md | 16 +++++----------- docs/install.md | 24 +++++++++++++++++++----- 3 files changed, 24 insertions(+), 17 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 6ac5fb5f..9273c4a9 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,4 @@ title: RtBrick BNG Blaster description: The BNG Blaster is a test tool to simulate thousands of PPPoE or IPoE subscribers including IPTV, traffic verification and convergence testing capabilities. -show_downloads: true logo: images/rtbrick_logo.png theme: jekyll-theme-minimal diff --git a/docs/index.md b/docs/index.md index d6011072..a68498b4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,4 @@ -# RtBrick BNG Blaster - -The BNG Blaster is a test tool to simulate thousands of PPPoE or IPoE subscribers including IPTV, -traffic verification and convergence testing capabilities. - -A short introduction can be found on [YouTube](https://youtu.be/EHJ70p0_Sw0 "BNG Blaster") -or checkout the documentation for details. - -![BBL Interactive](images/bbl_interactive.png "BNG Blaster (Interactive Mode)") - -## Documentation +# Documentation - [Introduction](intro) - [Installation](install) @@ -18,6 +8,10 @@ or checkout the documentation for details. - [Control Socket](ctrl) - [Multicast](multicast) +A short introduction can be found on [YouTube](https://youtu.be/EHJ70p0_Sw0 "BNG Blaster"). + +![BBL Interactive](images/bbl_interactive.png "BNG Blaster (Interactive Mode)") + ## License BNG Blaster is licensed under the BSD 3-Clause License, which means that you are free to get and use it for diff --git a/docs/install.md b/docs/install.md index cbcc83d5..87604628 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,5 +1,19 @@ # Installation +## Install Ubuntu + +Install dependencies: +``` +sudo apt install -y libssl1.1 libncurses5 libjansson4 +``` + +Download and install debian package: +https://github.com/rtbrick/bngblaster/releases + +``` +sudo dpkg -i +``` + ## Build from Sources ### Dependencies @@ -8,11 +22,11 @@ The BNG Blaster has dependencies to the RtBrick libdict fork (https://github.com/rtbrick/libdict) and the following standard dependencies: ``` -sudo apt install -y cmake -sudo apt install -y libcunit1-dev -sudo apt install -y libncurses5-dev -sudo apt install -y libssl-dev -sudo apt install -y libjansson-dev +sudo apt install -y cmake \ + libcunit1-dev \ + libncurses5-dev \ + libssl-dev \ + libjansson-dev ``` ### Build