Skip to content

Commit

Permalink
Merge pull request mlabs-haskell#35 from mlabs-haskell/uhbif19/update…
Browse files Browse the repository at this point in the history
…-readme

Remove todos and update test docs in README
  • Loading branch information
uhbif19 authored Apr 18, 2024
2 parents a767148 + edf97a1 commit 1ab8050
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

# CEM SDK

* @todo #3 Take decision if to change project name to CEM SDK
* @todo #3 Found out if we can make PDD bot descriptions and mentions less noisy

## Project pitch

Define and reuse Cardano DApp logic via annotated CEM-machines, resulting in free implementations for:
Expand All @@ -26,6 +23,14 @@ https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-star

## Running tests

Tests are runned in emulated environment by default.

Just run: `cabal test`.

For development and fast response once could consider `ghcid`.

## Starting local devnet

Tests depend on localdevnet, which is runned in Docker.
To start it do:

Expand All @@ -35,10 +40,6 @@ docker-compose -f docker-compose.devnet.yaml up
sudo chown -R $USER:$USER ./devnet/
```

After that run: `cabal test`.

For development and fast response once could consider `ghcid`.

## Devnet stalling bug

Sometimes devnet stalls, due to some bug, in that case one should restart it,
Expand Down

0 comments on commit 1ab8050

Please sign in to comment.