Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Merge pull request #29 from 18F/gbinal-patch-1

addressing broken links
  • Loading branch information...
afeld committed Nov 4, 2016
2 parents 2d74ee2 + 8340c69 commit c1e479c827b6eb75d1057abf4f183b6d406821b4
Showing with 1 addition and 3 deletions.
  1. +1 −3 pages/making-readmes-readable.md
@@ -34,9 +34,7 @@ This should answer the question: **How do I get this project to work on my machi

Important: If relevant code changes, it’s important to test to ensure these instructions continue to work. We also recommend separating the sections for using a project versus developing for it. (More detailed instructions are located [in our guidelines](https://pages.18f.gov/open-source-program/pages/maintainer_guidelines/#usage-documentation) for writing documentation for users, contributors, and developers.)

**Example:** The README for 18F’s homepage contains detailed instructions for [developing the site](https://github.com/18F/18f.gsa.gov#developing-the-site) and [deploying the site](https://github.com/18F/18f.gsa.gov#deploying-the-site).

**Example:** The README for Midas contains a link to [installation instructions](https://github.com/18F/midas/blob/devel/INSTALL.md) for developers.
**Example:** The README for analytics.usa.gov contains detailed instructions for [developing the site](https://github.com/18f/analytics.usa.gov#setup) and [deploying the site](https://github.com/18f/analytics.usa.gov#deploying-to-staging-18f-specific).

## Instructions for how people can help.

0 comments on commit c1e479c

Please sign in to comment.
You can’t perform that action at this time.