29.07.2016 Views

front-end-developer_1_

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Front-End-Developer - Level 1<br />

README template<br />

Every GitHub repository should include a README.md file that provides the visitor to the<br />

repo with the general information about the repository and the code it stores. The<br />

README.md file should be stored at the top level of the project folder. GitHub will look for<br />

this file and present it on the main viewing page of the repository.<br />

README Information<br />

Every README should have these five parts:<br />

A description of the project's purpose<br />

Complete setup instructions<br />

Names of contributors<br />

A copyright with the date<br />

License information<br />

And could additionally include sections for:<br />

Technologies used<br />

Known bugs<br />

Contact information<br />

Support or Contribution instructions<br />

README Template<br />

Here is some README text for you to use in your apps. It's already written in Markdown, so<br />

it will be nicely formatted on Github. If you aren't familiar with Markdown check out<br />

Markdown Live Preview to get familiar.<br />

It's worth taking the time to make your README look nice because it will be the first thing<br />

anyone will see in any of your projects. If people see that you have a messy or incomplete<br />

README, they will assume that your code is also messy or incomplete. But if you have a<br />

README template<br />

82

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!