arlon icon indicating copy to clipboard operation
arlon copied to clipboard

Published 20 hours ago • verified publisher icon arlonproj

[Documentation] : Reorganise the README

Open cruizen opened this issue 2 years ago • 0 comments

Break down the README.md into multiple files. The README.md will be an introduction to the project. Introduce separate docs for

  • Architecture, design
  • User's guide
  • Operator's guide (Deployment from release artifacts, configuration)
  • Developer's guide (installation, building, testing, guide to branching)
  • Changelog / release notes
  • etc.

cruizen avatar Sep 14 '22 16:09 cruizen