4.1 Prepare Code for Release

Last updated on 2025-04-10 | Edit this page

Overview

Questions

  • FIXME

Objectives

  • Construct a README file which contains all necessary elements
  • Describe the main types of software documentation (tutorials, how to guides, reference and explanation)
  • Implement basic project documentation using a documentation generator such as mkdocs
  • Explain why adding licensing information to a repository is important
  • Outline your rights and obligations under common types of license (e.g. the GPL, MIT, BSD, Apache 2 and Creative Commons licenses)
  • Apply an appropriate license to a code repository that is shared on Github
  • Understand how to create a release on GitHub
Key Points
  • FIXME