From f6a704524054a320bfdb8850bde2c26d890a88cf Mon Sep 17 00:00:00 2001 From: Diana Carvalho Date: Mon, 6 Jan 2025 11:55:11 +0000 Subject: [PATCH] docs: Link gitbook docs in the readmes Took 43 minutes --- Readme.md | 1 + examples/quickstart/Readme.md | 3 +++ 2 files changed, 4 insertions(+) diff --git a/Readme.md b/Readme.md index e614e311..3263f6b9 100644 --- a/Readme.md +++ b/Readme.md @@ -7,6 +7,7 @@ Moves slow on-chain computations off-chain to solve optimization problems. This crate allows simulating a set of supported protocols off-chain. Currently, it has a focus on token exchange protocols, but it is not necessarily limited to this. To get started, see our Quickstart guide [here](./examples/quickstart/Readme.md). +For complete documentation, see Tycho docs [here](https://docs.propellerheads.xyz/tycho/for-solvers/simulation). > **See also:** > The `evm` module allows for simulating _any_ transaction; it is agnostic to protocol. See module's diff --git a/examples/quickstart/Readme.md b/examples/quickstart/Readme.md index 26d4d3fb..c37183ba 100644 --- a/examples/quickstart/Readme.md +++ b/examples/quickstart/Readme.md @@ -13,3 +13,6 @@ This quickstart guide enables you to: export RPC_URL= cargo run --release --example quickstart ``` + +See [here](https://docs.propellerheads.xyz/tycho/for-solvers/tycho-quickstart) a complete guide on how to run the +Quickstart example. \ No newline at end of file