Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to avr-rust.org #48

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/workflows/mdbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Build the AVR-Rust mdBook site and deploy to GitHub Pages
name: Deploy mdBook site to Pages

concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install mdBook
run: |
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
rustup update
cargo install mdbook
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Build site using mdBook
run: mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./book
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
on:
push:
branches: ["master"]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
34 changes: 0 additions & 34 deletions .github/workflows/publish.yml

This file was deleted.

16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,19 @@

A guidebook for AVR-Rust development.

Hosted on [book.avr-rust.com/](https://book.avr-rust.com/).
Hosted on [book.avr-rust.org/](https://book.avr-rust.org/).

## Building the book
## Build dependencies

Install `mdbook`. Yes, you can get it through `cargo install`.
Install mdBook:

Then run `mdbook build`.
If rust and cargo are installed, you can build mdBook from source and install using `cargo install mdbook`.

mdBook's documentation also details [all mdBook installation methods](https://rust-lang.github.io/mdBook/guide/installation.html).

## Building the AVR documentation book

Run `mdbook build`.

By default the book is output to the `book` directory and the HTML index is output to `book/index.html`.

41 changes: 0 additions & 41 deletions update-github-pages.sh

This file was deleted.