learn-co-curriculum / readme-template

Lesson Title

All Readmes should follow a similar format when it comes to structure. Please refer to the style guide for a detailed explaination of standards.

Learning Goals

• Check out this Readme on writing Learning Goals

Introduction

Sometimes called an Overview, this section should contain a brief summary of what the lesson contains. Great introductions present a problem that is solved by the concepts reviewed in this lesson.

Contents

Lessons often contain multiple sections of content. Use the Learning Goals you've defined to guide you on what sections and sub-sections are needed.

Refer to this guide for assistance when writing Readmes

Conclusion

Wrap up the lesson with a brief review of what was covered. This is often a good place to connect the concepts discussed within a larger context.

Resources

This is an optional section, but list and link to resources, articles, and websites that you think will be beneficial for additional reading. Also, if your written contents included external links, it may be good to add a second reference here:

• Style Guide
• Writing Learning Goals
• Writing Readmes

View Readme Template.