Skip to content

Commit

Permalink
Updated readme and cargo toml comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Shourya742 committed Jan 19, 2024
1 parent d26e5bb commit cccae82
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 15 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ bitcoind = {version = "0.32", features = ["25_0"] }
#Empty default feature set, (helpful to generalise in github actions)
[features]
default = ["integration-test"]
# The following feature set is in response to the issue described at https://github.com/rust-lang/rust/issues/45599
# Only used for running the integration tests
integration-test = []

16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,26 +60,12 @@ $ cargo build

The project includes both unit and integration tests. The integration tests simulates various edge cases of the coinswap protocol.

To run the unit tests:
To run the tests:

```console
# without logs
$ cargo test

# with logs
$ cargo test -- --nocapture
```

To run the integration tests, `--features integration-test` flag must be enabled. Run integration tests with:

```console
# without logs
$ cargo test --features integration-test

# with logs
$ cargo test --features integration-test -- --nocapture
```

For manual swaps using the `teleport` app, follow the instructions in [Run Teleport](./docs/run_teleport.md).

For in-depth developer documentation on protocol workflow and implementation, consult [Developer's Resources](./docs/developer_resources.md).
Expand Down

0 comments on commit cccae82

Please sign in to comment.