Skip to content

Commit

Permalink
readme: edits
Browse files Browse the repository at this point in the history
Experiment with <details> and <summary> tags. Include all demo
applications.
  • Loading branch information
coot committed Jan 12, 2021
1 parent bf8579c commit 2885e87
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions README.md
Expand Up @@ -30,7 +30,7 @@ the Cardano Shelley implementation:
This document is a technical specification of the networking protocol. It
includes serialisation formats, necessary details of multiplexer and
technical specifications of mini-protocols used by either _node-to-node_ and
_node-to-client_ flavors of the protocol.
_node-to-client_ flavours of the protocol.

* [Haddock documentation](https://input-output-hk.github.io/ouroboros-network/)

Expand All @@ -44,13 +44,33 @@ The API consists of three layers:

• versioning which is a map from version numbers to the above callbacks and version data (the tricky part here is that version data type can be different between different versions; there is a simple way of building this map using a semigroup). You can use `simpleSingletonVersion` if your application does not depend on negotiated version data. However, `Ouroboros.Network.NodeToNode` and `Ouroboros.Network.NodeToClient` expose `V1` api which hides versioning from the caller.

## Demo application
## Demo applications

* [demo-chain-sync](https://github.com/input-output-hk/ouroboros-network/wiki/Ouroboros-Network-Demo)
* [cardano-ping](https://github.com/input-output-hk/ouroboros-network/blob/master/network-mux/demo/cardano-ping.hs)
* [mux-demo](https://github.com/input-output-hk/ouroboros-network/blob/master/network-mux/demo/mux-demo.hs)
* [demo-ping-pong](https://github.com/input-output-hk/ouroboros-network/blob/master/ouroboros-network-framework/demo/ping-pong.hs)
* [named-pipe-demo](https://github.com/input-output-hk/ouroboros-network/blob/master/Win32-network/demo/named-pipe-demo.hs) (Windows only)
* [demo-ntp-client](https://github.com/input-output-hk/ouroboros-network/blob/master/ntp-client/demo/Main.hs)

<details>
<summary>Instructions</summary>
To run a demo type:

```
cabal run <DEMO_NAME> --
```

After `--` you will need to pass arguments, when a demo is run without
arguments it will specify what arguments it needs.
</details>

You can run a demo application, check
[chain-sync-demo](https://github.com/input-output-hk/ouroboros-network/wiki/Ouroboros-Network-Demo)
wiki page.

## Tests
<details>
<summary>
Network test components.
</summary>

### Typed Protocols test suite
```
Expand Down Expand Up @@ -84,6 +104,7 @@ or with `nix`
```
nix-build -A haskellPackages.ouroboros-consensus.checks
```
</details>

# Ouroboros-Consensus

Expand Down Expand Up @@ -125,6 +146,10 @@ nix-shell --run ./scripts/buildkite/check-stylish.sh
```

## Tests
<details>
<summary>
Consensus test components.
</summary>

### Consensus test suite
```
Expand Down Expand Up @@ -182,3 +207,4 @@ or with `nix`
```
nix-build -A haskellPackages.ouroboros-consensus-cardano-test.checks.test
```
</details>

0 comments on commit 2885e87

Please sign in to comment.