This README is for contributors. The tutorials are publicly available at https://eecs280staff.github.io/tutorials/.
EECS 280 C/C++ tools and tutorials.
The markup source files live in docs/. We're using GitHub pages to publish the docs/ folder using the Primer Spec custom theme.
For local spec development, render GitHub pages locally using the Primer Spec instructions. Summary:
If you're on WSL or Linux, set GEM_HOME to install Ruby packages locally. Do not use sudo! Here are recommended settings for your .bashrc, you'll get packages in something like ~/.gem/ruby/3.4/.
export GEM_HOME="$HOME/.gem/ruby/$(ruby -e 'print RUBY_VERSION[/\d+\.\d+/]')"
export PATH="$GEM_HOME/bin:$PATH"One time install:
$ gem install bundler
$ bundle installEvery day usage:
$ cd docs/
$ bundle exec jekyll serveTroubleshooting: Remove the lockfile and try again. It's not committed to avoid problems with GitHub Pages deploy.
$ rm Gemfile.lockWe generate previews of the spec website whenever a Pull Request modifies the docs/ directory. These previews are uploaded to https://preview.seshrs.ml/previews/eecs280staff/<repo-name>/<PR-number>/ using a marketplace GitHub Action (upload-to-primer-spec-preview). Check out the workflow definition for implementation details.
The documents in this repository are licensed under a Creative Commons Attribution-NonCommercial 4.0 License. You’re free to copy and share this document, but not to sell it. You may not share source code provided with the documents in this repository.