Skip to content

Commit

Permalink
Updated README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
EnriqueKhai committed Dec 27, 2021
1 parent 5e11552 commit 3557dfc
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 44 deletions.
58 changes: 29 additions & 29 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
BSD 3-Clause License

Copyright (c) 2021, Nigel Tan
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
BSD 3-Clause License
Copyright (c) 2021, Nigel Tan
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Kevlar2

Kevlar2 is a language-agnostic framework built to
automate black-box and regression testing workflows.
Kevlar2 is a language-agnostic, shell-based framework
built to automate regression testing workflows.

# Table of Contents

Expand All @@ -18,16 +18,14 @@ automate black-box and regression testing workflows.
- [Step 1: Define it](#step-1-define-it)
- [Step 2: Add a Template](#step-2-add-a-template)
- [Comments](#comments)
- [License & Copyright](#license-&-copyright)

# Overview

Before we begin, let's address the elephant in the room:
why "Kevlar2"? The hope is that we can help you *bulletproof*
your code by helping you automate regression tests!

Also, Kevlar2 is the next iteration of the original [Kevlar](https://github.com/EnriqueKhai/Kevlar)
project, a system I had developed for the purpose of
Competitive Programming.
why "Kevlar2"? We test code to make it robust, and it is
my greatest hope that Kevlar2 can help you **bulletproof**
yours!

## The Problem Today

Expand All @@ -45,16 +43,16 @@ testing framework from scratch?

## Universal Testing with Black-box(ing)

Kevlar2 achieves language-agnosticism by leveraging the
user's own shell (we support both `bash` and `zsh`) and
an idea from [black-box testing](https://en.wikipedia.org/wiki/Black-box_testing).
Kevlar2 achieves language-agnostic testing by leveraging
the user's native shell (we support both `bash` and `zsh`)
and an idea from [black-box testing](https://en.wikipedia.org/wiki/Black-box_testing).

By coordinating file redirects, we can drive any piece
of code with inputs and check its output at the other end,
By coordinating file redirects, we can **test** any piece
of code by driving it with inputs and checking its output,
so long as the user's shell can compile and execute the
source language.
source language (almost always a given).

That is why we say we can "add any language" because
That is why we say we can "support any language" - because
which *xyz* developer doesn't have *xyz* installed on
his or her machine?

Expand Down Expand Up @@ -205,3 +203,11 @@ because the `#` character is used in tests, run the
```
build.sh --no-parse
```

# License & Copyright

Copyright (c) 2021, Nigel Tan
All rights reserved.

This source code is licensed under the BSD-style license
found [here](LICENSE).

0 comments on commit 3557dfc

Please sign in to comment.