Permalink
Browse files

update readme to be DC specific

  • Loading branch information...
Zakk Fleischmann
Zakk Fleischmann committed Aug 17, 2018
1 parent f1fc0fc commit 06031cd8335e5030c869d8c5444a74f40c2eb13a
Showing with 15 additions and 22 deletions.
  1. +15 −22 README.md
@@ -5,34 +5,28 @@
Use this template to structure your READMEs for diagnostics.

Be sure to include a recent [`LICENSE`](LICENSE) and Markdown linter
configuration ([`.remarkrc`](.remarkrc)). Also, include an appropriate
`.gitignore`; these are usually found in specific technology templates, for
example [js-template](https://www.github.com/ga-wdi-boston/js-template).
configuration ([`.remarkrc`](.remarkrc)).

## Prerequisites

- Topics with which developers should be familiar with.
- Prerequisites are "just-in-time", so if I have a prerequisite that mentions
Sass, I would **not** need to include CSS as a prerequisite.
- [Links to previous materials](https://www.github.com/ga-wdi-boston/example)
are often useful.
- In a challenge, it is useful to link to reference material, such as talk
repositories.
* Topics with which developers should be familiar with.
* Prerequisites are "just-in-time", so if I have a prerequisite that mentions
Sass, I would **not** need to include CSS as a prerequisite.
* [Links to previous materials](https://www.youtube.com/watch?v=dQw4w9WgXcQ)
are often useful.
* In a challenge, it is useful to link to reference material, such as talk
repositories.

## Instructions

1. Fork and clone this repository.
1. Change into the new directory.
1. Install dependencies.
1. Create and checkout a new branch to work on.
1. Fulfill the listed requirements.

Starter code is available in [`lib/challenge.js`](lib/challenge.js). A pull
request is not required, but it is necessary if you want a code review.

You may wish to refer to [FAQs](https://github.com/ga-wdi-boston/meta/wiki/)
related to [forking,
cloning](https://github.com/ga-wdi-boston/meta/wiki/ForkAndClone).
Starter code is available in [`lib/challenge.js`](lib/challenge.js). You are
required to turn in your submission by making a pull request on the original
repository.

## Requirements

@@ -42,16 +36,15 @@ not how it will be written, with the exception of constraints you may wish to
place on implementation. It's a good idea to include the below paragraph
verbatim.

You should be running `grunt nag` before diagnosing any bugs, since it finds
some of the most common sources of errors. After `grunt nag` passes, you should
run `grunt test` to run the included tests. Tests will tell you whether of not
you've met these requirements.

## Bonus

Bonuses are described after the requirements, if included. They should be worked
on **only after** passing requirements.

Less experienced students should be able to complete the base requirements in
the alloted time for labs and in around 2 hours for homework; more experienced
students should be to complete the bonus.

Sometimes, we ask questions that promote thinking critically about code.

## [License](LICENSE)

0 comments on commit 06031cd

Please sign in to comment.