Skip to content

Commit b1554f8

Browse files
authored
Add dev/install requirements to README. (#211)
Signed-off-by: Zachary Newman <[email protected]>
1 parent 965aa95 commit b1554f8

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ The directories contain the following files:
3232

3333
### Install
3434

35+
`go-tuf` is tested on Go versions 1.16 and 1.17.
36+
3537
```bash
3638
go get github.com/theupdateframework/go-tuf/cmd/tuf
3739
```
@@ -540,3 +542,13 @@ $ tree .
540542
For the client package, see https://godoc.org/github.com/theupdateframework/go-tuf/client.
541543

542544
For the client CLI, see https://github.com/theupdateframework/go-tuf/tree/master/cmd/tuf-client.
545+
546+
## Development
547+
548+
For local development, `go-tuf` requires Go version 1.16 or 1.17.
549+
550+
The [Python interoperability tests](client/python_interop/) require Python 3
551+
(available as `python` on the `$PATH`) and the [`python-tuf`
552+
package](https://github.com/theupdateframework/python-tuf) installed (`pip
553+
install tuf`). To update the data for these tests requires Docker and make (see
554+
test data [README.md](client/python_interop/testdata/README.md) for details).

0 commit comments

Comments
 (0)