Welcome to the collaborative book repository for students of CS249r: Tiny Machine Learning at Harvard! This repository contains the source files of chapters and sections written by your peers. We're excited to see your contributions!
To contribute to the repository using pull requests, follow these steps:
-
Fork the Repository:
- Navigate to the repository's GitHub page and click the 'Fork' button at the top-right corner.
-
Clone Your Forked Repository:
git clone https://github.com/YOUR_USERNAME/cs249r_book.git
-
Navigate to the Repository:
cd cs249r_book -
Set Upstream Remote:
git remote add upstream https://github.com/harvard-edge/cs249r_book.git
-
Create a New Branch for your chapter/section:
git checkout -b name-of-your-new-branch
-
Make your edits for your chapter or section in Markdown.
-
Commit Changes to Your Branch:
git add . git commit -m "Briefly describe your changes"
-
Push Your Branch to Your Forked Repository:
git push origin name-of-your-new-branch
-
Navigate to your fork on GitHub and click the 'New pull request' button. Ensure you're comparing your branch from your fork to the
mainbranch of the originalharvard-edge/cs249r_bookrepository. -
Submit the pull request with a descriptive message.
The instructors will assess your pull request and provide feedback. Once it's approved, your contribution will be
integrated into the main branch, and the book's website will be updated.
For a more detailed guide on the CS249r documentation process and peer review, check here.
The book's website is automatically constructed from the gh-pages branch. Once reviewed, changes to main are merged
into gh-pages.
You can view the book's website at: https://harvard-edge.github.io/cs249r_book/
You need to have quarto installed for local rendering of the book. Please follow the Quarto installation instructions here.
Once that's done, the following command can be used to produce the HTML pages:
cd cs249r_book
quarto render
This project follows the all-contributors specification. Contributions of any kind are welcome!