Sales funnel content here linking back to main marketing website Code Institute
The Library
    • All Posts

    • Bootstrap
    • Careers
    • Django
    • Git & GitHub
    • Heroku
    • IDE
    • JavaScript
    • MongoDB
    • README.md
    • Resources
    • Troubleshooting
    • Account

    • Log in
    • Create account

Webinar video: How to write your README

Written by: anna_ci
|
Published: Aug. 10, 2021 |
Updated: Aug. 17, 2021
README.md

Important

This post is only relevant to the 4 project (4P) Code Institute course.

Not sure which course you are on?

The recording from my webinar on how to write your README documentation for your milestone projects.

IMPORTANT

This webinar was run for the students on the old 4 Project course, where the requirements for README documentation are considerably more than for the first 3 projects of the new 5 Project course.

If you are on the 5 Project course, you are not expected to go so in-depth with your documentation for your first 3 projects on the 5P course. Only when you get to your last two projects does it get this intensive.

If you are working on any of the first 3 projects for the 5P course, the content of this video should still be useful for you, but please use the sample readme links provided in the LMS for you to gauge the detail in which you need to go into for your project documentation.

Modal title
More posts about README.md

About the Author

anna_ci

Anna Greaves

Content Developer | Software Developer

Visit Profile

Related posts

  • How do you write the Deployment section of your README.md

Tags

advice documentation projects README tips
Code Institute Courses
Info about the difference between the 2 courses here.
  • All Posts |
  • Categories |
  • Search

Policies

  • Terms and Conditions
  • Privacy Policy
  • Plagiarism Policy
  • FAQs

About

Lorem ipsum dolor sit amet consectetur adipisicing elit. Soluta, omnis fuga cupiditate sit perferendis culpa at vitae officiis molestias, dolores nihil repellendus odio? Praesentium voluptas iusto numquam incidunt error unde?