codeforboston/project-template

Name: project-template

Owner: Code for Boston

Description: Template READMEs and Wiki pages for new and established projects.

Created: 2015-08-28 22:18:47.0

Updated: 2018-04-23 13:46:25.0

Pushed: 2015-11-16 20:04:21.0

Homepage: null

Size: 17

Language: null

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

How To Use This Template

Step 1

Clone the project-template repo using mirror. Sign in, and put the new repository name in the “Target Repo” section. After you've mirrored the repo, navigate to it in your account, and update the Description and Link at the top of the repo page.

Step 2

There is a file which is entitled readme-template.md. This contains the template for the readme to your new project. Follow the section headings and replace content as needed.

Note: you will need to rename the readme-tempate.md file to README.md and delete this file for it to show up on the repository home page.

Step 3

In the folder labeled wiki, there are individual page templates that need to be added to your project wiki in order to flesh out the project documentation.

Open each page individually in your editor and search for a string of four underscores (eg ). Hit select all, and replace with the name of your new project.

Step 4

Create a corresponding new page in the wiki for each text file in the wiki folder. Copy the text from each of the .md files to the new corresponding wiki pages.

Step 5

Carefully read through each page and customize the information according to the needs and character of your project.

Important! This is not a one-time step. It needs to be updated on a weekly basis.