Notes repository for CPSC 362 Software Engineering course with Dr. Christopher Ryu
The purpose of this repository is to act as a resource and record of the materials and concepts covered in this course. I try to keep my notes organized and complete as possible, but it can be hard, and if you see anything that could be corrected, improved, or added feel free to include that. It could help myself, or future students. Anyone is welcome to contribute!
No blank tests, test answers, or completed homework should be added to this repository.
Uploading projects as examples and records of work should be ok and is encouraged
if they are creative works and not something that can have answers copy/pasted.
Blank homework assignments are fine.
While I hope this can be a resource for myself and others,
that resource should and will adhere to strict academic integrity.
(note) The following instructions are courtesy of Stanford Vision Lab https://github.com/StanfordVL/cs131_notes I will be running through them and eventually customizing them for my own notes
-
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.
-
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.
-
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.
(note) (note) instructions courtesy of Stanford Vision Lab https://github.com/StanfordVL/cs131_notes