Merge branch 'master' into gregotto-patch-2

.github/workflows/deploy.yml

@@ -10,15 +10,17 @@ jobs:
     permissions:
       contents: read
     runs-on: ubuntu-latest
+
+    env:
+      CARGO_TERM_COLOR: always
+
     steps:
     - uses: actions/checkout@v3
       with:
         fetch-depth: 0
     - name: Install mdbook
       run: |
-        mkdir mdbook
-        curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
-        echo `pwd`/mdbook >> $GITHUB_PATH
+        cargo install --git https://github.com/montyly/mdBook.git mdbook || true
     - name: Build artifacts
       run: mdbook build
     - name: Upload artifact

CONTRIBUTING.md

@@ -46,3 +46,16 @@ To run `markdown-link-check`:
 ```bash
 $ find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check
 ```
+
+## Create the book
+
+We use `mdbook` to generate [secure-contracts.com](https://secure-contracts.com/).
+
+To run it locally:
+```
+$ cargo install --git https://github.com/montyly/mdBook.git mdbook
+$ mdbook build
+```
+
+
+Note: we use https://github.com/montyly/mdBook.git, which contains https://github.com/rust-lang/mdBook/pull/1584.

README.md

@@ -2,7 +2,9 @@
 
 ![](https://github.com/crytic/building-secure-contracts/workflows/CI/badge.svg) ![](https://github.com/crytic/building-secure-contracts/workflows/Echidna/badge.svg)
 
-Follow our guidelines and best practices to write secure smart contracts.
+This repository, brought to you by [Trail of Bits](https://www.trailofbits.com/), outlines guidelines and best practices to write secure smart contracts.
+
+We welcome contributions, and you can contribute by following our [contributing guidelines](https://github.com/crytic/building-secure-contracts/blob/master/CONTRIBUTING.md).
 
 **Table of contents:**
 
@@ -34,3 +36,7 @@ Follow our guidelines and best practices to write secure smart contracts.
     - exercises expected to require ~two hours to practically learn its operation.
 - [Resources](./resources): Various online resources
    - [Trail of Bits blogposts](./resources/tob_blogposts.md): List of blockchain related blogposts made by Trail of Bits
+
+
+# License
+secure-contracts and building-secure-contracts are licensed and distributed under the [AGPLv3 license](https://github.com/crytic/building-secure-contracts/blob/master/LICENSE). Contact us if you're looking for an exception to the terms.

book.toml

@@ -5,13 +5,14 @@ multilingual = false
 src = "."
 title = "Building Secure Contracts"
 description = "This repository, brought to you by Trail of Bits, outlines our guidelines and best practices to write secure smart contracts."
+logo = "static/TOB_Black.svg"
 
 [output.html]
 git-repository-url = "https://github.com/crytic/building-secure-contracts"
 edit-url-template = "https://github.com/crytic/building-secure-contracts/edit/master/{path}"
-default-theme = "ayu"
 cname = "crytic.github.io/building-secure-contracts"
 no-section-label = true
+additional-css = ["static/custom.css"]
 
 [output.html.fold]
 enable = true

program-analysis/echidna/README.md

@@ -6,12 +6,12 @@ Watch our [Fuzzing workshop](https://www.youtube.com/watch?v=QofNQxW_K08&list=PL
 
 **Table of contents:**
 
-- [Introduction](./introduction/README.md): Introductory material to fuzzing and Echidna
-- [Basic](./basic/README.md): Learn the first steps on how to use Echidna
-- [Advanced](./advanced/README.md): Learn advanced features of Echidna
+- [Introduction](introduction): Introductory material to fuzzing and Echidna
+- [Basic](basic): Learn the first steps on how to use Echidna
+- [Advanced](advanced): Learn advanced features of Echidna
 - [Fuzzing tips](./fuzzing_tips.md): General fuzzing tips
 - [Frequently Asked Questions](./frequently_asked_questions.md): Answers to common questions about Echidna
-- [Exercises](./exercises/README.md): Exercises 
+- [Exercises](exercises): Exercises 
 
 Join the team on Slack at: https://empireslacking.herokuapp.com/ #ethereum
 

static/custom.css

@@ -0,0 +1,7 @@
+.sidebar .sidebar-scrollbox .sidebar-book-logo img {
+    display: block;
+    margin-left: auto;
+    margin-right: auto;
+    width: 50%;
+    max-width: max-content;
+}