Did you assemble a project at Noisebridge? Spend 15-30 minutes writing a brief guide.
- To empower others to learn from your projects
- 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.
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?
Noisebridge Infrastructure - put it in the wiki.
- All the files that someone needs to perform your project in a directory named after your project:
your-project
- A quick outline of how to perform your project in:
your-project/README.md
- Avoid long sentences and long explanations
- 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)
- Use
example
andexample/README.md
as a template foryour-project
andyour-project/README.md
- 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
Don't worry about getting things wrong, go for it.
- download a
zip
file of this repository - choose a hyphenated project name (eg.
your-project
) - copy
example/README.md
toyour-project/README.md
- make a directory with the same name
your-project
- add project files in the directory
- zip the
your-project
folder intoyour-project.zip
and send it torobbintt (at) gmail.com
- Please include the subject line
Noisebridge Gung Heap Submission: your-project
- Please include the subject line