CircuitVerse.org

Restructure the Readme

What should you do?

  • Restructure the Readme to provide better comprehensibility.
  • Make the Readme modular, divide it into modules or subsections in an organized way.
  • Move Contributors section in the README.md to CONTRIBUTING.md.
  • Move the Setup instructions from Readme.md to Setup.md.
  • Add additional setup instructions for Ubuntu.
  • Refer to issue #460.

Task tags

  • medium
  • documentation

Students who completed this task

Josh Heng

Task type

  • chrome_reader_mode Documentation / Training
  • assessment Outreach / Research
close

2019