Skip to content

update README

update README #57

Workflow file for this run

name: Deploy docs
on:
push:
branches: ["main"]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: macos-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v3
- uses: mlugg/setup-zig@v1
with:
version: master
- name: Generate docs
run: |
make docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: 'zig-out/docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2