Skip to content

Commit b3a95d9

Browse files
committed
Link to /docs in root README
1 parent 3b5881d commit b3a95d9

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ NOTE: the examples do not handle fee management and will send transactions with
4343

4444
If not using the container above, please see an [example of custom bitcoin.conf](https://github.com/Merkleize/docker/blob/master/bitcoin.conf) to work with the scripts in this repository.
4545

46+
# Docs
47+
48+
See the [docs](./docs) folder for high-level documentation on how to design smart contracts using MATT.
49+
50+
As the framework is still in development, we recommend looking at the code examples below for developer documentation on using pymatt.
51+
4652
# Case studies
4753

4854
The `examples` folder contains some utility scripts to work with regtest bitcoin-core:

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This folder contains high level documentation on the MATT framework, and the core concepts used in the examples of smart contracts implemented in this repository.
22

33
- [matt](./matt.md)<br>Start here for a general introduction to MATT.
4-
- [contracts](./contracts.md)<br>How to build smart contracts based on state machines
4+
- [contracts](./contracts.md)<br>How to build smart contracts based on state machines.
55
- [checkcontractverify](./checkcontractverify.md)<br>Draft specs for the `OP_CHECKCONTRACTVERIFY` opcode.

0 commit comments

Comments
 (0)