pyyaml icon indicating copy to clipboard operation
pyyaml copied to clipboard

Incorporate user documentation to README

Open adehad opened this issue 4 years ago • 0 comments

Summary

  1. Proposes an outline for the README that incorporates the user documentation.

Style guide to follow

  • [ ] Each sentence starts on new line
  • [ ] Wrap at 79
  • [ ] 2 blank lines before headings
  • [ ] backtick fenced code blocks

Apparently GitHub has a .md toc sidebar that may help reviewing:

https://github.com/adehad/pyyaml#readme

image

adehad avatar Oct 27 '21 23:10 adehad