Skip to content

Commit

Permalink
docs(README): add tests section, typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
metamacro committed Sep 10, 2023
1 parent add22f2 commit 5494c70
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A Brainfuck interpreter written in the C programming language.

## Usage

Invoke the interpreter binary with one positional argument, i.e., the BrainFuck program path:
Invoke the interpreter binary with one positional argument, i.e. the BrainFuck program path, e.g.:

```
$ ./bfci /path/to/brainfuck/program.bf
Expand All @@ -29,13 +29,13 @@ After cloning the repository, make sure to:
```
$ git submodule update --init
```
Or simply build the project once, since the process is automated via`CMake`.
Or simply build the project once, since the process is automated via `CMake`.

## Build

Clone the repository via the preferred method.

Generate the build recipes via `CMake`:
Generate the build recipes via `CMake`, e.g.:

```
$ mkdir build
Expand All @@ -57,6 +57,20 @@ Invoke the build via `Make`:
build $ make
```

## Build

Enable the tests by setting the `ENABLE_TESTS` `CMake` option to `ON`, e.g.:

```
build $ cmake -D ENABLE_TESTS=ON ..
```

Execute the tests, e.g.:

```
build $ ctest
```

## Examples

The `examples` directory contains `BrainFuck` example programs.
Expand Down

0 comments on commit 5494c70

Please sign in to comment.