CS131 Computer Vision: Foundations and Applications
Instructions for creating class notes
Overall workflow
-
Fork this repository by clicking the "Fork" button on the top right of this page.
-
Next, clone your forked repository into your local machine:
git clone github.com/YOUR_GITHUB_ACCOUNT/cs131_notes.git
- Give others permission to commit to your forked repository by clicking on "Settings" and then "Collaborators".
- Write up the class notes.
- Push your changes to your forked repository.
- Send a pull request to the official repository.
Downloading the software and testing the repository.
-
Download pdfltex so that you can compile the tex documents. You can also use Overleaf or Sharelatex to compile your tex documents.
-
Go into the template folder and compile the format and template files:
cd template
pdflatex format.tex
bibtex format
pdflatex format.tex
pdflatex template.tex
bibtex template
pdflatex template.tex
- Make sure that template.pdf and format.pdf have been generated and are correctly displayed. Read format.pdf to understand how we expect the class notes to be formatted.
Writing class notes for a given lecture
-
Create a folder called
LectureXXwhereXXis01for the first lecture or18for the eighteenth lecture. -
Copy over template.tex and bibliography.bib to your folder.
cp template/template.tex lectureXX/lectureXX.tex
cp template/bibliography.bib lectureXX/bibliography.bib
-
Write the lecture notes. Make sure to include pictures, references and tables. If you add images, make sure to give credit to the source of those images.
-
Compile your lecture template to make sure that it formats correctly.
cd lectureXX
pdflatex lectureXX.tex
bibtex lectureXX
pdflatex lectureXX.tex
- Submit a pull request to have your lecture notes merged.