Maintain a project readme.md file (16/28)

Often you’ll do things in a project that have to be done in a certain way or require several steps to get correct. These steps aren’t always appropriate to document within your code comments, so instead get into the habit of making a note of these steps in a readme.md file in the root of the project. These notes don’t have to be complex, a simple bulleted list including relevant hyperlinks is good enough.

Contributor: Andrew Ward from andrewleeward.com

Written by Nathaniel Fried

Co-founder of Fupping. Busy churning out content and building an empire.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.