Skip to content
This repository has been archived by the owner on Sep 11, 2023. It is now read-only.

Readme update #117

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Pull Request (PR) into Circuits-Support-2022

***Delete the below block when actually making your PR!***

***Before making a pull request, you must:
Follow HyTech's [Github Software Guidelines](https://gtvault.sharepoint.com/:w:/r/sites/HyTechRacing2/Shared%20Documents/Electrical%20-%20All/HT06/Guidelines%20Rules%20and%20Procedures/Github%20Software%20Guidelines.docx?d=w7e0d7e36afeb47b5a935bd7a4851bceb&csf=1&web=1&e=sudzjV) to understand our development flow and pull request procedure.***

***Follow HyTech's [Electrical Designs Rules Review Process](https://gtvault.sharepoint.com/:w:/r/sites/HyTechRacing2/Shared%20Documents/Electrical%20-%20All/HT06/Guidelines%20Rules%20and%20Procedures/Electrical%20Designs%20Rules%20Review%20Process.docx?d=w0277498dfb4b4b9fbfad0e5db8a187c8&csf=1&web=1&e=LDFCNz) to understand circuit design flow and relevant Github procedures.***

***Follow HyTech's [Electrical Designs Rules Review Process](https://gtvault.sharepoint.com/:w:/r/sites/HyTechRacing2/Shared%20Documents/Electrical%20-%20All/HT06/Guidelines%20Rules%20and%20Procedures/Electrical%20Designs%20Rules%20Review%20Process.docx?d=w0277498dfb4b4b9fbfad0e5db8a187c8&csf=1&web=1&e=LDFCNz) to understand circuit design flow and relevant Github procedures.***
***If you made a new part for the library, please make sure that it complies with all parts of the [HyTech EAGLE Library Style Guide](https://gtvault.sharepoint.com/:w:/s/HyTechRacing2/EbFCu5uSk-JAn6JOtRveoY8BFpta20LwK2nkDpP1ih_pnA?e=igv3fK).***

***Your PR should not cause any merge conflicts, so please merge the `main` branch into your branch before submitting. It is your responsibility to ensure that the merge does not break something before submitting. [Here](https://guides.github.com/features/mastering-markdown/) is a good resource for markdown formatting as you fill out this template. See this [example](https://github.com/hytech-racing/circuits-support-2022/pull/9). Feel free to ask any electrical lead if you have any questions! Delete this block when actually making your PR!***
***Your PR should not cause any merge conflicts, so please merge the `main` branch into your branch before submitting. It is your responsibility to ensure that the merge does not break something before submitting. [Here](https://guides.github.com/features/mastering-markdown/) is a good resource for markdown formatting as you fill out this template. See this [example](https://github.com/hytech-racing/circuits-support-2022/pull/9). Feel free to ask any electrical lead if you have any questions!***

## Part Description
*Describe the contents of the pull request. List all the devices you added. Also list any footprints or symbols you modified. If changing other supporting files, please give details on what those changes are.*
Expand Down
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
![HyTech Logo](https://hytechracing.gatech.edu/images/hytech_logo_small.png)
![HyTech Logo](https://hytechracing.gatech.edu/images/hytech_logo.png)

# 2022 Circuits Support

Repository for all of the EAGLE support files for the 2022 car.

## Getting Started with this Git Repository
1. Follow HyTech's [Software Guide](https://github.com/hytech-racing/training/tree/master/Resources).
2. Create a GitHub account if you don't already have one.
1. Create a GitHub account if you don't already have one.
2. Follow HyTech's [Software Guide](https://github.com/hytech-racing/training/tree/master/Resources).
3. Download and install [GitHub Desktop](https://desktop.github.com/) (basic) or [Git CLI](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (advanced).
* If you are using GitHub Desktop for the first time, be sure to read the [User Guide](https://help.github.com/desktop/guides/).
* If you are using Git for the first time, you should start off by reading a tutorial. There are many available online:
* [Pro Git book](https://git-scm.com/book/en/v2)
* [Git Tutorial](https://git-scm.com/docs/gittutorial)
* [Atlassian Git Tutorial](https://www.atlassian.com/git/tutorials/)
* You may want to keep a copy of [GitHub's Git Cheat Sheet](https://services.github.com/kit/downloads/github-git-cheat-sheet.pdf) as a reference.
4. Talk to your subteam lead to be added to the team within the GitHub organization.
5. Clone this repository to your computer using the URLs:
* SSH: `[email protected]:hytech-racing/circuits-support-2022.git`
* HTTPS: `https://github.com/hytech-racing/circuits-support-2022.git`

## Github Software Guidelines and Electrical Designs Rules Review Process
Follow HyTech's [Github Software Guidelines](https://gtvault.sharepoint.com/:w:/r/sites/HyTechRacing2/Shared%20Documents/Electrical%20-%20All/HT06/Guidelines%20Rules%20and%20Procedures/Github%20Software%20Guidelines.docx?d=w7e0d7e36afeb47b5a935bd7a4851bceb&csf=1&web=1&e=sudzjV) to understand our development flow and pull request procedure.
Follow HyTech's [Electrical Designs Rules Review Process](https://gtvault.sharepoint.com/:w:/r/sites/HyTechRacing2/Shared%20Documents/Electrical%20-%20All/HT06/Guidelines%20Rules%20and%20Procedures/Electrical%20Designs%20Rules%20Review%20Process.docx?d=w0277498dfb4b4b9fbfad0e5db8a187c8&csf=1&web=1&e=LDFCNz) to understand circuit design flow.

## Getting Started with EAGLE
1. Follow HyTech's [Software Guide](https://github.com/hytech-racing/training/tree/master/Resources).
2. Download and install [EAGLE](https://www.autodesk.com/products/eagle/overview)
2. Download and install Autodesk [EAGLE](https://www.autodesk.com/products/eagle/overview)
3. Get the free [Educational License](https://www.autodesk.com/education/free-software/eagle) (a .edu email address is required)

## Github Software Guidelines and Electrical Designs Rules Review Process
Follow HyTech's [Github Software Guidelines](https://gtvault.sharepoint.com/:w:/r/sites/HyTechRacing2/Shared%20Documents/Electrical%20-%20All/HT06/Guidelines%20Rules%20and%20Procedures/Github%20Software%20Guidelines.docx?d=w7e0d7e36afeb47b5a935bd7a4851bceb&csf=1&web=1&e=sudzjV) to understand our development flow and pull request procedure.
Follow HyTech's [Electrical Designs Rules Review Process](https://gtvault.sharepoint.com/:w:/r/sites/HyTechRacing2/Shared%20Documents/Electrical%20-%20All/HT06/Guidelines%20Rules%20and%20Procedures/Electrical%20Designs%20Rules%20Review%20Process.docx?d=w0277498dfb4b4b9fbfad0e5db8a187c8&csf=1&web=1&e=LDFCNz) to understand circuit design flow.

## More Information
* [Software Guide](https://github.com/hytech-racing/training/tree/master/Resources)
* [Team Site](https://hytechracing.gatech.edu/)
* [Facebook](https://www.facebook.com/HyTechRacing/)
* [Instagram](https://www.instagram.com/hytech.racing/)
* [Engage](https://gatech.campuslabs.com/engage/organization/hytech-racing)

## License
Expand Down