|
2 | 2 | Interested in submitting to OnBoard? You're in the right place!
|
3 | 3 |
|
4 | 4 | ## 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 | + |
7 | 8 |
|
8 | 9 | ## 2. Design a Board!
|
9 | 10 | It's design time! Head over to an eCAD software of your choice (EasyEDA, KiCAD, Eagle) and start designing!
|
10 | 11 |
|
11 | 12 | Never designed before? No problem! We have design resources for EasyEDA, a free online eCAD program. Check them out here.
|
12 | 13 |
|
13 | 14 | ## 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. |
15 | 16 |
|
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. |
17 | 18 |
|
18 | 19 | ## 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 | + |
| 23 | + |
| 24 | + |
| 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 | + |
| 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 | + |
| 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! |
20 | 43 |
|
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`. |
22 | 46 |
|
| 47 | + |
23 | 48 |
|
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! |
25 | 50 |
|
| 51 | + |
26 | 52 |
|
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! |
29 | 55 |
|
| 56 | + |
0 commit comments