From 3b9bf3b73a08f3c573c9d72c408d121cece208bf Mon Sep 17 00:00:00 2001 From: Micke Nordin Date: Mon, 4 Jul 2022 21:59:16 +0200 Subject: [PATCH] Update readme --- README => Readme.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) rename README => Readme.md (55%) diff --git a/README b/Readme.md similarity index 55% rename from README rename to Readme.md index 00aa534..41ab634 100644 --- a/README +++ b/Readme.md @@ -1,21 +1,34 @@ +# begin + This is a free implementation of the Cisco ios/asa/catalyst output modifier "begin" released under GNU GPL v.2 or any later version. -http://www.cisco.com/en/US/docs/ios/preface/usingios.html#wp1012384 +[Cisco output modifiers manual](https://www.cisco.com/c/en/us/td/docs/ios-xml/ios/fundamentals/configuration/15_sy/fundamentals-15-sy-book/cf-shw-cmd-out-redirect.pdf) -DEPENDENCIES +## DEPENDENCIES This program depends on boost/xpressive header only library as well as boost/iostreams. On RedHat(-ish) systems do: +```bash yum install boost-devel - +``` On debian do: +```bash apt-get install libboost-regex-dev libboost-iostreams-dev - +``` before installation -INSTALLATION -git clone git://github.com/mickenordin/begin.git +## INSTALLATION + +```bash +git clone https://code.smolnet.org/micke/begin.git cd begin meson build ninja -C build sudo ninja -C build install +``` + +## USAGE + +``` +begin [-z|-j] [filename] +```