Skip to content

Commit

Permalink
README: Fix some syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
markjdb committed Nov 29, 2024
1 parent 3c79bb5 commit 3505cf9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ $ bricoler run freebsd-src-regression-suite-run -p freebsd-src:url=/path/to/clon
Add "--show" to list the available parameters. Run "bricoler run" without any
other arguments to list available tasks.

== Compatibility ==
## Compatibility

This project only runs on FreeBSD. It is written in Lua as part of an experiment
to try and build up a set of libraries exposing low-level interfaces in FreeBSD,
Expand All @@ -27,18 +27,20 @@ pf, jails, bhyve, ZFS, etc.. This makes cross-platform support difficult. If
it becomes tempting to run bricoler on other platforms, a rewrite in Python or
similar would likely be necessary.

== Building ==
## Building

It requires Lua 5.4 and cmake.

To build it, run "make" from the root directory.

== FreeBSD regression suite quickstart ==
## FreeBSD regression suite quickstart

On FreeBSD main, run the following:

```
$ git clone https://github.com/markjdb/bricoler
$ cd bricoler && make
```

If you run bash, try sourcing bricoler/bricoler-completion.bash.
It auto-completes parameter names; I find it very very useful.
Expand Down

0 comments on commit 3505cf9

Please sign in to comment.