Search code examples
githubsymlinkmonoreporeadme

how to set up a symbolic link for README.md in a monorepo on github

given a structure like

/ my_mono_repo
.. readme.md
.. / packages
.. / .. / package_blue
.. / .. /.. readme.md
.. / .. / package_red
.. / .. /.. readme.md

I would like to have a single readme.md in the root
and just a link for the single packages
something like this (I cloned it to peak the solution, but with no success)

can someone enlight me?

Solution

  • sure, but how does this apply on github?

    It does apply on GitHub in that the README will be stored, as seen in rrousselGit/river_pod/packages/riverpod/README.md as a symlink: with the relative path in it:

    ../../README.md

    And it will have a special type in the index (120000, similar to Linux file mode)