Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document usage of git submodules #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

This repository contains code examples for [go-perun](https://github.com/hyperledger-labs/go-perun).

## Setup

Some of the examples presented in this repository make use of [git submodules](https://git-scm.com/book/de/v2/Git-Tools-Submodule). You will need to pull the submodules in order to use the respective examples:

``` shell
git submodule init
git submodule update
```

## License

The source code in this repository is made available under the Apache License, Version 2.0.
Expand Down