This change moves the README.md content to src/README.md and creates a symbolic link between README.md and src/README.md, this makes src/README.md the source of truth but allows GitHub to properly render the README.md file
Feedback
Is this something we want to implement?
Is there a simpler way to do this?
Could this cause confusion in the future?
Requirements
[x] I've read and understood the
Contributing Guidelines
and have done my best effort to follow them.
Summary
This PR aim to allow denoland to display the readme.md from this repository while maintaining a single source of truth for the readme
Testing
Test this out from this branch
Special notes
This change moves the
README.md
content tosrc/README.md
and creates a symbolic link betweenREADME.md
andsrc/README.md
, this makessrc/README.md
the source of truth but allows GitHub to properly render theREADME.md
fileFeedback
Requirements