docs: add companion codebase page

bitcoindevkit · Jan 29, 2024 · cf8ebf1 · cf8ebf1
1 parent d2d42fb
commit cf8ebf1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/getting-started/companion-code.md b/docs/getting-started/companion-code.md
@@ -0,0 +1,17 @@
+# Companion Codebase
+
+This book comes with a series of [code examples, one for each of the pages in the book]. You can run any of the examples from your command line like so:
+
+```shell
+cd companion-code/esplora
+cargo run --bin esplora
+```
+
+Alternatively, if you have the [just] tool installed, you can use:
+```shell
+cd companion-code
+just esplora
+```
+
+[code examples, one for each of the pages in the book]: https://github.com/bitcoindevkit/book-of-bdk/tree/master/companion-code
+[just]: https://github.com/casey/just
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -73,6 +73,7 @@ nav:
     - About: index.md
     - Project Organization: getting-started/organization.md
     - Getting Started: getting-started/getting-started.md
+    - Companion Codebase: getting-started/companion-code.md
   - Book:
     - Complete Examples:
       - Electrum Wallet: book/electrum-wallet.md