Skip to content

A heap of gung ho projects from many contributors

Notifications You must be signed in to change notification settings

startling/gung-heap

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Noisebridge Gung Heap

Did you assemble a project at Noisebridge? Spend 15-30 minutes writing a brief guide.

Why?

  1. To empower others to learn from your projects
  2. To share knowledge with the people after you

"Gung Heap" is a quasi-portmanteau of "Gung Ho" and "Dung Heap". It is inspired by the Programmer Archaeologists of the Qeng Ho, pronounced Chung Ho and rhyming with "Gung Ho". So, consider yourself a programmer archaeologist when you use this stuff.

Also, the [census-wg](need a wiki link) is hoping to quantify the projects that Noisebridge facilitates. This record can be used to get more grants/money/tools.

What?

All projects small and large, software and hardware, successes and failures (and incomplete), technical, artistic, and otherwise.

Test: Would others want to learn about your project and maybe try repeating it?

What doesn't go here?

Noisebridge Infrastructure - put it in the wiki.

Stuff You Need

  1. All the files that someone needs to perform your project in a directory named after your project: your-project
  2. A quick outline of how to perform your project in: your-project/README.md

Tips

  1. Avoid long sentences and long explanations
  2. Assume your reader knows the basics of all tools and software
    • Do include special techniques and special knowledge (e.g. how to get to a deeply hidden menu item)

Simple Walkthrough

  1. Use example and example/README.md as a template for your-project and your-project/README.md
  2. make a pull request (only do this if you don't need help)
    • If you can't make a pull request, just use the detailed walkthrough

Detailed Walkthrough

Don't worry about getting things wrong, go for it.

  1. download a zip file of this repository
  2. choose a hyphenated project name (eg. your-project)
  3. copy example/README.md to your-project/README.md
  4. make a directory with the same name your-project
  5. add project files in the directory
  6. zip the your-project folder into your-project.zip and send it to robbintt (at) gmail.com
    • Please include the subject line Noisebridge Gung Heap Submission: your-project

About

A heap of gung ho projects from many contributors

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 57.8%
  • CSS 25.7%
  • HTML 16.5%