diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index ff852bc..8346300 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -46,6 +46,8 @@ jobs: # Deployment job deploy: + if: ${{ github.ref == 'refs/heads/main' }} + environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} diff --git a/README.md b/README.md new file mode 100644 index 0000000..944eda8 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Context-Generic Programming Patterns + +## [Read the book](https://patterns.contextgeneric.dev/) + +## Overview + +This repository contains the source code for the book _Context-Generic Programming Patterns_. The published version of this book is available at https://patterns.contextgeneric.dev/. + +## Build Instructions + +This book is built using [mdBook](https://rust-lang.github.io/mdBook/). Follow the [installation instructions](https://rust-lang.github.io/mdBook/guide/installation.html) to install mdBook on your machine. You can then serve a local version of the book by running: + +```bash +mdbook serve +``` + +The output HTML files are stored at the `book/` directory. For more commands available, refer to the [official mdBook documentation]((https://rust-lang.github.io/mdBook/)). \ No newline at end of file