Skip to content

Commit fe35d0c

Browse files
committed
Add README
Signed-off-by: Christopher Crone <[email protected]>
1 parent 19cd13a commit fe35d0c

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Compose specification compliance test suite
2+
3+
This repository contains a test suite for testing Compose implementations to
4+
ensure that they correctly implement the Compose specification. The current
5+
state of the test suite is that it is a work in progress and contributions are
6+
welcome!
7+
8+
## Getting started
9+
10+
By default, the test suite is run against the
11+
[Compose reference implementation](https://github.com/compose-spec/compose-ref)
12+
which uses the Docker Engine.
13+
14+
### Prerequisites
15+
16+
* [Docker](https://docs.docker.com/install/)
17+
* [compose-ref](https://github.com/compose-spec/compose-ref) in your PATH
18+
* Ensure that you have no running containers (see [issue](https://github.com/compose-spec/compatibility-test-suite/issues/5))
19+
20+
### Running the tests
21+
22+
Using the defaults, you can run the tests as follows:
23+
24+
```console
25+
$ make test
26+
```

0 commit comments

Comments
 (0)