Skip to content

Commit

Permalink
update Readme with rendering instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
venpopov committed Nov 15, 2024
1 parent fdb4742 commit 192d552
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
A utility repository to build a quarto book website for the BMM Developer Notes for the bmm package: https://github.com/venpopov/bmm

The contents of the `_book` directory contain the rendered website, and they are automatically pushed via Github Action to the gh-pages branch of `bmm`
The contents of the `_book` directory contain the rendered website, and they are automatically pushed via Github Action to the gh-pages branch of `bmm`.

## How to makes changes

1. Make the changes to the .qmd files
2. Run `quarto render` from the terminal to render the book
3. Commit and push the changes to the `master` branch

0 comments on commit 192d552

Please sign in to comment.