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

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

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

In your first milestone (and future ones) there are 5 whole points out of 100 awarded for your deployment write up. But a lot of new students don't really get what that means, and so their writeup misses out on points that are actually very easy to get.

Deployment means what you did to make your website live and working for other people to look at.

Deployment is not pushing from GitPod to GitHub, and it is not the preview that GitPod gives you to view your working code.

For the first two milestones, Deployment is getting your site working on GitHub pages (It gets a lot more complex in the last two milestones!)So when you come to deploy your site to GitHub Pages, you need to take a few steps to do that in the GitHub settings. How to do that can be found here: https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages

You need to include these steps in your readme on how it was deployed.

Basically explain to another developer who might work on your code, how you got the page up and running. (Later in the course the deployment section will get more complex, but if you want the best marks be pedantic and write it out in your readme this time too!)

Also, the deployment includes writing up how to run your code locally. So explain how to pull your code from your Github repository (you don't need to give any passwords) so someone could clone your code to work on their own machine. Here is how to do that: https://help.github.com/en/articles/cloning-a-repository Include these steps in your readme.md too and that's the deployment section of your readme sorted.

Modal title
More posts about README.md

About the Author

anna_ci

Anna Greaves

Content Developer | Software Developer

Visit Profile

Related posts

  • Webinar video: How to write your README

Tags

advice deployment markdown README
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?