This is the main repository for the EE reference sheet. It is built using LaTeX, with the following conventions:
- only sections and subsections are listed in the table of contents. There should only be a need
for one level under that, so please use
\subsubsection*{}for those so that they don't show up in the table of contents. - Use
-for itemized lists - Please push to a branch and create a pull request from that branch to
main. Do not push directly tomain. - Please make sure things compile before creating a PR. It's a massive pain otherwise.
You will need to connect your computer to GitHub via SSH. I recommend asking ChatGPT, going on YouTube, or following this tutorial:
Once the repository is cloned, check out the branch you want using:
git checkout the-branch-I-want
Once you are ready to add your changes, use the following in the command line:
git add .
git commit -m "Commit message, like I changed some stuff and it's great"
git push
Once you've pushed, create a pull request using GitHub.
- Go to
Pull Requests - Click on
New Pull Request - There will be two branches shown. The left one should show
base: main. Leave that one alone. Change the other to the branch you've worked on, so that the one on the right is pointing to the one on the left, like "Compare my branch to main and pull any changes that I've made from my branch to main". - Click
Create Pull Request. It will then go to review and will be merged once everything checks out.