README

These notes accompany the Stanford CS class CS131, Computer Vision: Foundations and Applications. This is a development space for the class notes where you can commit your changes as your team builds the notes for your assigned lecture, and once you're down we will merge your notes onto the finished website.

Head over to https://anarcomey.github.io/cs131_notes_dev/ to see what the web page notes that you'll create will look like!

Steps to create your own notes

To begin writing your own notes that will appear on a website like this https://anarcomey.github.io/cs131_notes_dev/, have one team member fork the repository building this web page and configure the fork to build a web page for your team to develop on!

• Step 1: Fork the repository: Fork this repository https://github.com/ANarcomey/cs131_notes_dev into your own GitHub account

• Step 2: Enable GitHub Pages: Enter settings from the menu bar in your forked repo, find the "GitHub Pages" heading, and choose the defaults of "master" branch and "root" directory so that your settings look like the figure below, except "anarcomey" will be replaced with the github username of the team member who created the fork. Don't worry about choosing a theme or any other settings, we've configured that all for you.

• Step 3: Link the repository to your GitHub Page: In your forked repository, edit the file _config.yml. Update the url field to https://your_github_username.github.io and either remove the email field or set it to one of your team members emails if you want to receive build updates by email.

• Step 4: Submit: Create a group Gradescope submission with all of your teammates and submit the url of your GitHub Page containing your notes (e.g. https://your_github_username.github.io/cs131_notes_dev/ and the url of your repository (e.g. https://github.com/your_GitHub_username/cs131_notes_dev).

Steps to update your notes

Now that your notes are live in your own GitHub fork and running at https://your_github_username.github.io/cs131_notes_dev/, you'll want to add content and update them. To do that, find the Markdown file for your lecture in the _chapters directory and edit the .md file. Once you've made your desired updates and want to see what they look like online, commit and push your changes to the master branch. The newly pushed code will render online in ~< a minute and you can see your notes! Once you have a handle on the basic mechanics of Markdown, you can write most of your notes without having to push code and render very often. Take a look at some examples and a template with Markdown guidance in the Intructions module of the website, and also look at the markdown code creating those pages in the .md files in _chapters/instructions.

Since you're working in groups and editing the same Markdown file, it might make things easier to collaboratively edit a shared document. Since this code is in Markdown, Google Colab Notebooks are a great tool! They're the google docs of jupyter notebooks. We've provided an example Colab notebook that you can copy and use for collaboratively developing your notes: link, but you're free to use any tools or collaboration structures you wish!

Optional local setup

If the iteration time of waiting for the github web page to load your changes is too slow for you, you can install the Ruby and Jekyll software behind the web page on your own machine and render the web page locally. Typically the load time for new changes is under a minute, so you really shouldn't need to do this.

Local setup

1. Install Jekyll: https://jekyllrb.com/docs/installation/
2. Clone this repository if you haven't already:

git clone ...

3. Install dependencies:

# From cs131_notes_dev/ directory
bundle install

Local development

1. Launch server:

# From cs131_notes_dev/ directory
bundle exec jekyll serve

2. Navigate to localhost:4000/cs131_notes_dev/ in your web browser! That / at the end matters!
3. Modify notes and save — local site should update automatically (just refresh).