Skip to content

Commit 6c00d8b

Browse files
committed
created first draft of directions
1 parent 6184478 commit 6c00d8b

20 files changed

+96
-38
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+5-11
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22

33
- [ ] I am 19 or under.
44
- [ ] I am a current high school student (or younger).
5-
- [ ] I am a member of the Hack Club Slack (Join at <https://hackclub.com/slack>).
5+
- [ ] I am a member of the Hack Club Slack (Join [here](https://hackclub.com/slack>)).
66
- [ ] I have followed [DIRECTIONS.md](https://github.com/hackclub/OnBoard/directions.md)
7-
- [ ] Uploaded design files to my fork of `OnBoard-template`
8-
- [ ] My board passes JLCPCB inspection
9-
- [ ] Filled out my contact card (below)
10-
11-
**Contact Card:**
12-
```yml
13-
Name:
14-
Slack Handle:
15-
Project Name:
16-
```
7+
- [ ] Created a folder under `onboard/projects`
8+
- [ ] Filled out `TEMPLATE.md`
9+
- [ ] Uploaded Gerber and design files
10+
- [ ] Uploaded screen shot of PCB passing JLCPCB inspection

.gitmodules

-16
This file was deleted.

DIRECTIONS.md

+36-9
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,55 @@
22
Interested in submitting to OnBoard? You're in the right place!
33

44
## 1. Fork!
5-
- [ ] Fork of this repo [`onboard`](https://github.com/hackclub/OnBoard/)! This is the where you'll add your project and eventually PR from.
6-
- [ ] Fork [`Onboard-template`](https://github.com/hackclub/OnBoard-template/) and give it a name! This will be your project repo where you store your design files, Gerbers, and budget.
5+
Fork the [`onboard`](https://github.com/hackclub/OnBoard/) repo! This is the where you'll add your project files and eventually PR from!
6+
7+
![Fork the OnBoard repo](docs/images/directions/OnBoard-Fork.png)
78

89
## 2. Design a Board!
910
It's design time! Head over to an eCAD software of your choice (EasyEDA, KiCAD, Eagle) and start designing!
1011

1112
Never designed before? No problem! We have design resources for EasyEDA, a free online eCAD program. Check them out here.
1213

1314
## 3. Upload to JLCPCB and Check
14-
- [ ] Upload your Gerber files to JLCPCB and make sure they pass inspection.
15+
Upload your Gerber files to JLCPCB and make sure they pass inspection. This is done by going to check out and selecting the review before paying option.
1516

16-
This is **VITAL** since your project will only be approved if it passes inspection. Take a screen shot. You'll include this in your PR later.
17+
This is **VITAL** since your project will only be approved if it passes inspection. **Take a screen shot**. You'll include this in your PR later.
1718

1819
## 4. Add Your Design to Your Project Repo
19-
- [ ] Add your design files (schematics, PCB, and Gerbers) to the project repo you made earlier!
20+
From your fork of `OnBoard`, create a folder with your project name under `OnBoard/projects`. To do this, go to the projects folder and click `Create new file`.
21+
22+
![Projects folder](/docs/images/directions/projects.png)
23+
24+
![Create new file](/docs/images/directions/add-file.png)
25+
26+
Then in the box labeled `name your file...`, type in `GITHUB_USERNAME/README.md`. This creates a README file under a folder called your Github username.
27+
28+
![Creating a folder](/docs/images/directions//creating-a-folder.png)
29+
30+
After this, copy and paste the contents of [`TEMPLATE.md`](./projects/!Template/TEMPLATE.md) into the text editor and fill it out!
31+
32+
![Paste in TEMPLATE.md](docs/images/directions/paste-in-template.png)
33+
34+
Press the big green `Commit changes` button to save!
35+
36+
Once this is done, go under your folder and begin uploading your Gerber, design files, and screen shot of JLCPCB approval. In all, you should have the follow files under your project folder:
37+
- [ ] `Gerbers.zip`: This should be the file that you send off to JLCPCB.
38+
- [ ] `JLCPCB.png`: A screen shot of JLCPCB approving your board
39+
- [ ] Design files (`design.json`, `design.sch`, `design.brd`, etc). Whatever format your designer outputs to should be included.
40+
- [ ] `README.md`: A filled out [`TEMPLATE.md`](./TEMPLATE.md), renamed to `README.md`
41+
42+
If you have all the above, you're done with this step!
2043

21-
## 5. Add Your Project to OnBoard
44+
## 6. Create a PR!
45+
Once you've uploaded your files, you can merge them to the main repo through a pull request! Under the contribute tab of your forked repo, click the big green `Open pull request`.
2246

47+
![Open a PR](docs/images/directions/open-pr.png)
2348

24-
## 6. Create A PR
49+
That will bring you to the main repo, where you'll initiate a pull request. Follow the checklist, we'll then review your PR and you'll be off to the races!
2550

51+
![Submission checklist](docs/images/directions/submission-checklist.png)
2652

27-
## 7. Celebrate!
28-
Post photos of your board in `#onboard`! Can't wait to see what you make!
53+
## 7. Ship it!
54+
Post photos of your board in `#onboard`! We can't wait to see what you make!
2955

56+
![John sharing PCB](docs/images/directions/john-sharing-pcb.png)

docs/design_resources.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Never designed a PCB before? You're in the right place! The OnBoard community ha
1010

1111
## PCB Tutorials
1212

13-
## Reputable Manufactures
13+
FILL ME IN!
12.5 KB
Loading

docs/images/directions/add-file.png

18.8 KB
Loading
21.9 KB
Loading
112 KB
Loading

docs/images/directions/open-pr.png

88.8 KB
Loading
28.4 KB
Loading

docs/images/directions/projects.png

109 KB
Loading
Loading

projects/!Template/Gerbers.zip

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remember to upload your Gerber files!

projects/!Template/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Template
2+
Hey there! This is a template for what you'll need to upload to GitHub to receive a grant for OnBoard!
3+
4+
Everything should reside in `onboard/projects/YOUR-PROJECT-NAME`.
5+
6+
Items that must be included:
7+
- [ ] `Gerbers.zip`: This should be the file that you send off to JLCPCB.
8+
- [ ] `JLCPCB.png`: A screen shot of JLCPCB approving your board
9+
- [ ] Design files (`design.json`, `design.sch`, `design.brd`, etc). Whatever format your designer outputs to should be included.
10+
- [ ] `README.md`: A filled out [`TEMPLATE.md`](./TEMPLATE.md), renamed to `README.md`

projects/!Template/TEMPLATE.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: "NAME"
3+
slack_handle: "SLACK HANDLE"
4+
github_handle: "GITHUB HANDLE"
5+
project: "PROJECT NAME"
6+
---
7+
8+
# PROJECT NAME
9+
## Summary
10+
##### Describe your board in 2-3 sentences. What are you making? What will it do?
11+
12+
## Plan
13+
##### How much is it going to cost? What's your timeline?
14+
15+
## Design
16+
##### Tell us a little bit about your design process. What were some challenges? What helped? ***Totally optional**

projects/!Template/design.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.json containing exports from EasyEDA.

projects/!Template/design.sch

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Here would be where I put my schematic file.
2+
If you're using EasyEDA, you'll have have .json file.

projects/OnBoard-template

-1
This file was deleted.

projects/Orpheus-Leap/README.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: "Kevin Yang"
3+
slack-handle: "keviny"
4+
github-handle: "bykevinyang"
5+
project: "Orpheus Leap"
6+
---
7+
8+
# Orpheus Leap
9+
10+
## Summary
11+
##### Describe your board in 2-3 sentences. What are you making? What will it do?
12+
The Leap was a board I designed during to congratulate everyone in Summer of Making! It's a Arduino Leonardo in the shape of our lord and savior, Orpheus! We made 500 of them and shipped them to makers around the world!
13+
14+
## Plan
15+
##### How much is it going to cost? What's your timeline?
16+
The Leap costed ~$6 per board. I made it during the Summer of 2020 🏖️.
17+
18+
## Design
19+
##### Tell us a little bit about your design philosophy. What were some challenges? What helped? ***Totally optional**
20+
I wanted the Leap to be a beautiful sendoff for Summer of Making. It's components follow the natural contours of Orpheus. She's also fully functional, able ot act as a USB device (the pros of using an Arduino Leonardo).
21+
22+
The board shape was defined in Adobe Illustrator, cleaned up in Fusion 360, and routed in Eagle. If you have questions about making wacky shaped boards, hit me up on slack `@Kevin Yang`.
23+
24+
#### This folder is an example for OnBoard

projects/summer/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)