Welcome to the DSLC Rust Programming Language Book Club!
We are working together to read The Rust Programming Language by Steve Klabnik and Carol Nichols, with contributions from the Rust Community (copyright 2024).
Join the #book_club-rust channel on the DSLC Slack to participate. As we read, we are producing slides for the book.
If you would like to present, please see the sign-up sheet for your cohort (linked below, and pinned in the #book_club-rust channel on Slack)!
- Cohort 1 (started 2024-10-07, facilitated by Andrew Bates): Mondays, 4:00 PM CST/CDT | meeting videos
This repository is structured as a Quarto website. To present, follow these instructions:
Do these steps once:
- Setup Git and GitHub to work with RStudio (click through for detailed, step-by-step instructions; I recommend checking this out even if you're pretty sure you're all set).
usethis::create_from_github("r4ds/bookclub-rust")
(cleanly creates your own copy of this repository).
Do these steps each time you present another chapter:
- Open your project for this book.
usethis::pr_init("my-chapter")
(creates a branch for your work, to avoid confusion, making sure that you have the latest changes from other contributors; replacemy-chapter
with a descriptive name, ideally).devtools::install_dev_deps()
(installs any packages used by the book that you don't already have installed).- Edit the appropriate chapter file (in
slides/
). Use#
and##
to indicate new slides. - If you use any packages that are not already in the
DESCRIPTION
, add them. You can useusethis::use_package("myCoolPackage")
to add them quickly! - Build the book! ctrl-shift-b (or command-shift-b) will render the full book, or ctrl-shift-k (command-shift-k) to render just your slides. Please do this to make sure it works before you push your changes up to the main repo!
- Commit your changes (either through the command line or using Rstudio's Git tab).
usethis::pr_push()
(pushes the changes up to github, and opens a "pull request" (PR) to let us know your work is ready).- (If we request changes, make them)
- When your PR has been accepted ("merged"),
usethis::pr_finish()
to close out your branch and prepare your local repository for future work. - Now that your local copy is up-to-date with the main repo, you need to update your remote fork. Run
gert::git_push("origin")
or click thePush
button on theGit
tab of Rstudio.
When your PR is checked into the main branch, the bookdown site will rebuild, adding your slides to this site.
Please note that the bookclub-rust project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.