https://github.com/codeforboston/project-template

Template READMEs and Wiki pages for new and established projects.
https://github.com/codeforboston/project-template

Last synced: 4 months ago
JSON representation

Template READMEs and Wiki pages for new and established projects.

• Host: GitHub
• URL: https://github.com/codeforboston/project-template
• Owner: codeforboston
• License: mit
• Created: 2015-08-28T22:18:47.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-11-16T20:04:21.000Z (over 10 years ago)
• Last Synced: 2025-09-11T19:18:34.809Z (9 months ago)
• Size: 16.6 KB
• Stars: 4
• Watchers: 8
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README-template.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Project Name

## What

What is this and what is it for? Put a meaningful, short, plain-language description of what this project is trying to accomplish and why it matters. Briefly describe the problem this project solves. For more details, see [____ wiki What's this all about page](TODO put in right link).

## Who

Who are you? Who are your partners? Links, logos, and lots of credit-giving.

#### Status

Is it done? Is it a prototype? Is it a zombie? Are you researching or designing? Alpha, Beta, 1.1, etc.

It's OK to write a sentence, too. The goal is to let interested people know where this project is at, so they know whether they should contribute. This is also a good place to link to the [CHANGELOG](CHANGELOG.md).

#### Screenshots

![Infinite Windmills](http://i.giphy.com/SIV3ijAwkNt9C.gif)

## Why

A more in detail explanation for why this project exists. Tell us all about it.

## How

Links to Hackpad, the Wiki, other (usually [Markdown](http://daringfireball.net/projects/markdown/syntax)) files that help people get up and running.

Make sure to include needs you have for work from non-coders.  This could include writing, design, graphics, research, marketing, testers, policy wonks.  

## License

A link to the [LICENSE.md](LICENCE.md) file. Some projects choose to copy it here verbatim.