update readme
parent
0f63fd1e57
commit
5617f5aa2a
40
README.md
40
README.md
|
@ -7,3 +7,43 @@
|
|||
|
||||
This repository contains the base chain implementation that Colinear's compute marketplace uses as a settlement layer.
|
||||
|
||||
## Validators
|
||||
|
||||
### Requirements
|
||||
|
||||
- `docker >= 20.10.*`
|
||||
|
||||
## Development
|
||||
|
||||
### Requirements
|
||||
|
||||
- `ignite` - [CLI Installation Guide](https://docs.ignite.com/guide/install)
|
||||
- `go >= 1.18`
|
||||
- `bash`
|
||||
- `jq`
|
||||
|
||||
### Setup
|
||||
|
||||
To build the chain:
|
||||
|
||||
```ignite chain build```
|
||||
|
||||
To serve the chain:
|
||||
|
||||
```ignite chain serve```
|
||||
|
||||
### Unit Tests
|
||||
|
||||
Unit tests use Go's built-in testing system. To test any specific feature or subpackage:
|
||||
|
||||
```go test ./path/to/package```
|
||||
|
||||
### Integration Tests
|
||||
|
||||
Integration tests use a custom bash testing framework that interacts with a running instance of the chain. To run all integration tests:
|
||||
|
||||
```make test```
|
||||
|
||||
Integration tests can also be run individually:
|
||||
|
||||
```./tests/<specific_test>.sh```
|
||||
|
|
Loading…
Reference in New Issue