# retest
Retest is a regular expression tester that can be used in the terminal. It is meant to be a simple and quick utility.

## Compiling
You can install dependencies and compile all at once using `cargo`:

    $ cargo build

## Installing
A simple `Makefile` is provided for easily installing and uninstalling retest. To install, run

    $ sudo make install

This will complile retest and place a globally available executable into `/usr/local/bin`. Similarly, you can uninstall retest with

    $ sudo make uninstall


## Usage
Retest accepts one regular expression as an argument, and then matches it against a subject string. The subject will be printed back out, with all matches found highlighted. For example:

    $ echo 'fee fi fo fum' | retest '\w+\s'

By default, the subject is read from standard input. If you'd like to specify the subject as an argument, you can use the `--subject` (or `-s`) option:

    $ retest '\w+\s' --subject 'fee fi fo fum'

For more details, check the help message from the program:

    $ retest --help

# retest
Retest is a regular expression tester that can be used in the terminal. It is meant to be a simple and quick utility.

## Install from release
Binaries for Linux are provided for each release and available on the [releases page](https://github.com/coderstephen/retest/releases). Just download a "retest" binary and place it somewhere that is in your $PATH (like `/usr/local/bin`), and you're ready to go.

## Compiling and installing from source
First, get the source code by cloning from GitHub:

    $ git clone https://github.com/coderstephen/retest.git
    $ cd retest

You can install dependencies and compile all at once using `cargo`:

    $ cargo build

A simple `Makefile` is also provided for easily installing and uninstalling retest. To install globally, you can follow the traditional Linux steps:

    $ make
    $ sudo make install

This will compile retest and place a globally available executable into `/usr/local/bin`. Similarly, you can uninstall retest with

    $ sudo make uninstall

## Usage
Retest accepts one regular expression as an argument, and then matches it against a subject string. The subject will be printed back out, with all matches found highlighted. For example:

    $ echo 'fee fi fo fum' | retest '\w+\s'

By default, the subject is read from standard input. If you'd like to specify the subject as an argument, you can use the `--subject` (or `-s`) option:

    $ retest '\w+\s' --subject 'fee fi fo fum'

For more details, check the help message from the program:

    $ retest --help

Add install from release steps
Add install from release steps
