From f7a93b3fade6a670b2140bb61a09e4c3565e19ff Mon Sep 17 00:00:00 2001 From: "Leutner, Benjamin" Date: Tue, 26 Apr 2022 11:18:50 +0200 Subject: [PATCH] add install instructions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 640f35d..bb38948 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,22 @@ grep "pattern1|pattern2|pattern3" reference_file However, if you have a lot of patterns you want to match with GNU grep you will at some point hit the limits of argument length. Big grep uses a pattern file where each line is a pattern, and matches those -Note that compilation requires libboost-regex headers, because I wanted to be able to user Perl-style regexes and usually have boost available in all my environments. +## Installation +Note that compilation requires libboost-regex headers, because I wanted to be able to user Perl-style regexes and usually have boost available in all my environments (`libboost-regex-dev` on Ubuntu). + +```bash +# Clone +git clone https://github.com/bleutner/big_grep.git +cd big_grep + +# Compile +make + +## Run +bin/big_grep -h +``` + +## Usage ``` USAGE: big_grep [args] -p -i