Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
soareschen committed Apr 7, 2024
1 parent 6e0333f commit 0504e58
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ jobs:

# Deployment job
deploy:
if: ${{ github.ref == 'refs/heads/main' }}

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)).

0 comments on commit 0504e58

Please sign in to comment.