mirror of
https://github.com/System-End/highway.git
synced 2026-04-19 22:05:13 +00:00
updated docs
This commit is contained in:
Alex Ren
parent
b96109dbcb
commit
f8ff8c82ca
5 changed files with 85 additions and 106 deletions
|
|
@ -10,7 +10,7 @@
|
|||
<%= link_to "Part Sourcing", advanced_page_path("part-sourcing"), class: "#{current_page?(advanced_page_path("part-sourcing")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 px-6 rounded transition duration-100 block font-dystopian" %>
|
||||
<%= link_to "Design Guide", advanced_page_path("design-guide"), class: "#{current_page?(advanced_page_path("design-guide")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 px-6 rounded transition duration-100 block font-dystopian" %>
|
||||
<%= link_to "What is shipping?", advanced_page_path("shipping"), class: "#{current_page?(advanced_page_path("shipping")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block font-dystopian" %>
|
||||
<%# <%= link_to "FAQ", advanced_page_path("faq"), class: "#{current_page?(advanced_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %>
|
||||
<%# <%= link_to "Other communities", advanced_page_path("faq"), class: "#{current_page?(advanced_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block font-dystopian" %>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
13
app/views/advanced/inspiration.md
Normal file
13
app/views/advanced/inspiration.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Project inspiration
|
||||
|
||||
|
||||
|
||||
Here's a list of ideas that we think would be cool!
|
||||
## Hack Club stuff!
|
||||
|
||||
### Regular Custom projects
|
||||
- Claw machine
|
||||
- 3D printer, but with a twist
|
||||
|
||||
|
||||
## Sources
|
||||
|
|
@ -4,46 +4,36 @@ Decided to make a custom project? Awesome! Right this way.
|
|||
|
||||
Whatever that one project you've been thinking of doing forever - whether that be a custom 3D printer, a full mechanical keyboard, or something else - now's your chance to make that real
|
||||
|
||||
You can choose from one of the following tiers:
|
||||
|
||||
- A 4 point project with up to $50 USD in funding
|
||||
- A 6 point project with up to $150 USD in funding
|
||||
- A 10 point project with up to $350 USD in funding
|
||||
|
||||
The more points a project is worth, the higher the complexity & quality requirements will be. Please read over the [Project guidelines](/advanced/project-guidelines) to get a better idea of what they are
|
||||
|
||||
Before you go crazy with ideas though - please be resourceful! This is **not** a free money glitch. [Hack Club](https://hackclub.com) is a financially limited non profit, and every dollar we can save together goes towards the next program.
|
||||
|
||||
Any questions? Join the #highway channel in slack!
|
||||
Any questions? Ask in the #highway channel in slack!
|
||||
|
||||
**Before starting your project, please read over the [Project Guidelines](/advanced/project-guidelines) and [Submission Info](/advanced/submitting) pages so that you have an idea of what you're doing**
|
||||
|
||||
---
|
||||
|
||||
### Here's how to get started:
|
||||
## Here's how it works:
|
||||
|
||||
1. Make a new GitHub repository for it! This will be where you add your project
|
||||
2. Start a journal by creating a file called JOURNAL.md and commit it
|
||||
3. Make a [pull request](https://github.com/hackclub/highway/tree/main) to **add your project to the site gallery**!
|
||||
4. Start designing your project! Journal each day you work on it!
|
||||
5. [Submit](/advanced/submitting) your project when you're done
|
||||
6. If you're accepted, we'll give you the grant!
|
||||
|
||||
**To add your project to the site gallery, head on over to the [submissions.yml](https://github.com/hackclub/highway/blob/main/submissions.yml) in the site's repository and add your repo URL:**
|
||||
### 1. Set up your project & add it to the gallery
|
||||
|
||||
```
|
||||
projects:
|
||||
- "https://github.com/Dongathan-Jong/SpotifyDisplay"
|
||||
- "your_repo_link"
|
||||
```
|
||||
<br>
|
||||
As long as your PR doesn't have any conflicts, we'll merge it and your submission will be added to the project list! Other people will be able to see your journal & see what you're up to.
|
||||
Before you start working on your project, you need to do some setup:
|
||||
|
||||
After that, you're done! You can move onto designing.
|
||||
#### 1. Create a git repository for your project
|
||||
|
||||
**Check out projects others have started in the [Gallery](/projects)!**
|
||||
Create a repository for your project! Most people use GitHub, but you can use any git provider you want
|
||||
|
||||
Each project you design that is approved gets you **6 points**, or **10 points** if you build an extra advanced project (scroll to bottom)
|
||||
#### 2. Start your journal
|
||||
|
||||
---
|
||||
Next, start a journal by creating a JOURNAL.md file in your repo. At the very top, include the following data:
|
||||
|
||||
### On Journaling
|
||||
|
||||
This is *the* most important part of the whole process! Journaling your progress is how to keep track of how your project is going. Beyond that, it's also a way to tell a story and have something to look back at many years down the line.
|
||||
|
||||
At the top of your JOURNAL.md file, include this metadata *(include the quotation marks)*:
|
||||
|
||||
```
|
||||
---
|
||||
|
|
@ -53,8 +43,49 @@ description: "Describe your project in a short sentence!"
|
|||
created_at: "2024-03-20"
|
||||
---
|
||||
```
|
||||
Journaling is mandatory for custom projects
|
||||
|
||||
#### 3. Make a PR to add it to the gallery
|
||||
|
||||
Next, add it to the gallery! Make a pull request to the [submissions.yml](https://github.com/hackclub/highway/blob/main/submissions.yml) file in the site's repository and add your project's URL
|
||||
|
||||
```
|
||||
projects:
|
||||
- "https://github.com/Dongathan-Jong/SpotifyDisplay"
|
||||
- "your_repo_link"
|
||||
```
|
||||
|
||||
As long as your PR doesn't have any conflicts, we'll merge it and your submission will be added to the project list! Other people will be able to see your journal & see what you're up to.
|
||||
|
||||
### 2. Start designing!
|
||||
|
||||
Start designing your project! Check out the resources on the left side for inspo, part sourcing, etc
|
||||
|
||||
|
||||
### 3. Submit your design
|
||||
|
||||
Submit to https://forms.hackclub.com/highway
|
||||
|
||||
(If you're submitting for 10 points, please send it in #highway-pitstop before submitting the form)
|
||||
|
||||
### 4. Get a grant to build it!
|
||||
|
||||
Once you're approved, you'll get an HCB Credit Card with the funding you submitted for, and a *half* of the points that your project is worth
|
||||
|
||||
|
||||
### Submit your finished project
|
||||
|
||||
To collect the other half of your points, you need to actually submit your physically built project! To do so, fill out the following form:
|
||||
|
||||
(form WIP, will be out when people are done projcts)
|
||||
|
||||
|
||||
---
|
||||
|
||||
### On Journaling
|
||||
|
||||
This is *the* most important part of the whole process! Journaling your progress is how to keep track of how your project is going. Beyond that, it's also a way to tell a story and have something to look back at many years down the line.
|
||||
|
||||
<br>
|
||||
Don't just journal your wins! It's much, *much* better to maintain a smaller, more consistent one every day - it'll capture a more realistic story to what things were really like. Fails are important too.
|
||||
|
||||
Journaling is **mandatory** to get your submission approved! Poor quality journals will be rejected.
|
||||
|
|
@ -77,7 +108,7 @@ Do NOT have:
|
|||
- Wall of timestamps with barely any descriptions
|
||||
- No images
|
||||
- Terrible formatting that's impossible to read
|
||||
- AI generated journal entries; anything written by AI will be automatically rejected
|
||||
- AI generated journal entries; anything written by AI will be immediately rejected
|
||||
|
||||
Generally, it's OK if english isn't your first language and you're not the best at it. We're not marking you on your writing skills! What does matter is you try your best, the words are your own (no generative AI), and it's legible.
|
||||
|
||||
|
|
@ -91,22 +122,6 @@ Most projects (keyboards, game consoles, custom devboards, etc) can all be built
|
|||
|
||||
Some projects though are above and beyond - a DIY 5-axis 3D printer, a go-kart from scratch, etc take significantly more time, require a larger budget, and are overall a lot harder to execute.
|
||||
|
||||
These projects should not be attempted unless you have *some* sort hardware experience in the past - even if it's just a starter project
|
||||
|
||||
**If you think you have the idea & ability to execute:**
|
||||
|
||||
Pitch your idea in [#highway-pitstop](https://hackclub.slack.com/archives/C08S22XRYMU) with:
|
||||
|
||||
- A very brief description of what it is
|
||||
- Rough BOM w/ costs
|
||||
- What specifically you would have to design & what the process would look like - KEEP IT VERY BRIEF, BULLET POINTS ONLY
|
||||
- If applicable, link a couple references of what you're thinking of
|
||||
- 1-2 past projects you've made that gives you the confidence to pull this off
|
||||
- Why the complexity warrants 10 points
|
||||
|
||||
Even if the project would fit under $150, if it's particularly complicated (beyond the standard project guidelines) then you should still pitch it in pitstop! Worst case you get some feedback on your idea
|
||||
|
||||
Please format your pitch with bolded text, bullet points, etc to make it easier to parse
|
||||
|
||||
**@alexren will respond with whether it's approved. Do not start if you are not approved**
|
||||
If this is you, then pitch your project in [#highway-pitstop](https://hackclub.slack.com/archives/C08S22XRYMU) when you're almost done!
|
||||
|
||||
Even if the project would fit under $150, if it's particularly complicated (beyond the standard project guidelines) then you should still pitch it in pitstop! Worst case you get some feedback on your project so far
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Guide
|
||||
# Overview
|
||||
|
||||
### Welcome to the **Highway** to **Undercity**, an unforgettable summer of hardware running from now through July 31st.
|
||||
|
||||
|
|
@ -6,8 +6,6 @@
|
|||
|
||||
If you've *never* done hardware before, this is *your* opportunity to get started. That one project you saw on YouTube but had no idea how to build? *That ends now.*
|
||||
|
||||
*If you're already a seasoned pro, this is your chance to really level up. That 5-axis 3D printer you've been thinking of? Now's your chance*.
|
||||
|
||||
**Earn points with each project you build.** Collect prizes along the way. Join your friends at Undercity, a 4 day hackathon in San Francisco at GitHub HQ.
|
||||
|
||||
*Don't forget to join the Hack Club Slack, our community. Need an invite? Enter your email on the [landing](/)!*
|
||||
|
|
@ -16,62 +14,17 @@ If you've *never* done hardware before, this is *your* opportunity to get starte
|
|||
---
|
||||
### 1. Build hardware projects
|
||||
|
||||
#### 1. Pick an idea
|
||||
Design & build hardware projects. You can either build fully [Custom Projecs](/advanced) (4/6/10 points) or [Starter Projects](/starter-projects) (4 points), or a mix of both!
|
||||
|
||||
Pick an idea! You can either choose a [Starter Project](/starter-projects) (4 points) or a [Custom Project](/advanced) (6 or 10 points)
|
||||
|
||||
[Starter Projects](/starter-projects) are guided resources that help you build awesome stuff like macropads just like the one below. In exchange, we'll ship you the parts you need to build it!
|
||||
[Starter Projects](/starter-projects) are existing Hack Club programs that teach you how to make one specific thing, i.e the macropad below. Design your own completely custom one, and we'll ship you the parts to build it.
|
||||
|
||||
<img src="https://hackpad.hackclub.com/orpheuspadpic.png" style="max-width: 400px;"></img>
|
||||
|
||||
[Custom projects](/advanced) are fully self-directed! You'll be responsible for all the research, and in return, you'll get a debit card of up to $350* USD to spend on your project! **You must journal your progress while working on custom projects**
|
||||
[Custom projects](/advanced) are fully self-directed! You'll be responsible for all the research, and in return, you'll get a debit card of up to $350* USD to spend on your project! *You must journal your progress while working on custom projects*
|
||||
|
||||
**by default you only get $150 USD, check out the [Custom Projects](/advanced) section to find out how you can get $350*
|
||||
(check out the top bar to see more about each path!)
|
||||
|
||||
#### 2. Start your project
|
||||
|
||||
Make a repository for your project! You can use any git provider, but most people use GitHub. Now, you can start making the PCB/CAD/code/more to your project!
|
||||
|
||||
**If you're making a Custom project:**
|
||||
|
||||
In the repository, create a file called JOURNAL.md - this will be where you keep track of your progress! Every single time you work on your project, you should jot down what you did and total hours spent. *Remember to commit the changes every time you work on it!*
|
||||
|
||||
**Before you work on your Custom project, make a pull request to add your project URL to the [submissions.yml](https://github.com/hackclub/highway/blob/main/submissions.yml) file in the Highway GitHub repo. Your project will appear in the [Gallery](/projects)!**
|
||||
|
||||
It should look something like this:
|
||||
|
||||
```
|
||||
projects:
|
||||
- "https://github.com/Dongathan-Jong/SpotifyDisplay"
|
||||
- "your_repo_link"
|
||||
```
|
||||
<br>
|
||||
More instructions on the [Custom Projects](/advanced/overview) page!
|
||||
|
||||
|
||||
#### 3. Ship the design
|
||||
Shipping your design means sharing it in a way that other people can use what you made! Include the following:
|
||||
|
||||
- A published design on a [GitHub](https://github.com/) repository
|
||||
- A nice README.md file with a description of what your project does & any images
|
||||
- Any source files that are used for your project
|
||||
|
||||
(*what you need specifically will change with each project, so make sure to double check the docs so that you have everything!*)
|
||||
|
||||
#### 4. Collect your points & parts
|
||||
Once you have a shipped project, submit it to our form here: [https://forms.hackclub.com/highway](https://forms.hackclub.com/highway)
|
||||
|
||||
**If you get approved** you'll get the following;
|
||||
|
||||
- Either a kit of parts (starter project), or a $350* credit card to build your design (custom project)!
|
||||
- A 3D printed case (printed by another Hack Clubber in your country, if you don't have a 3D printer)
|
||||
- A soldering kit, if you don't have one already
|
||||
|
||||
Approval is not guaranteed. Please go over the **submission requirements** of what you're making to make sure you don't get rejected!
|
||||
|
||||
Make sure to double check your design has everything you need before submitting!
|
||||
|
||||
If it is rejected for any reason, you'll need to wait **1 week** before you can get it re-reviewed.
|
||||
**You can make an unlimited amount of projects, so get building!**
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -10,17 +10,15 @@ As always, if you have any questions, ask in #highway-help!
|
|||
|
||||
## Overview
|
||||
|
||||
Points are awarded when you either:
|
||||
Points are there to qualify for highway!
|
||||
|
||||
- Get a design **approved**
|
||||
- *Note that not all submitted designs will be approved; they will get checked by a human first*
|
||||
- **Starter projects**: 4 points
|
||||
- **Custom projects**: 6 points by default, 10 for advanced projects.
|
||||
- **Custom projects**: 4
|
||||
- Physically build one of your projects
|
||||
|
||||
- Attend a Highway event
|
||||
- Generally, 1 point
|
||||
- Attending the Kickoff Call will give you 1 point!
|
||||
- Check the [Events](/events) tab for more!
|
||||
|
||||
By default, custom projects give you **6 points**, but if its a particularly complicated project (i.e 3D printer), you can get 10 points out from it!
|
||||
|
||||
To get 10 points, you MUST get confirmation on your idea BEFORE working on it first. Pitch it in #highway-pitstop + get a confirmation before working on it!
|
||||
Loading…
Add table
Reference in a new issue