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

Question

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?

Symbolic links are created with shell tools like `ln -s ../../README.md` — paiv, Mar 22 '21 at 19:27
You've posted the link to github where symbolic links are used https://github.com/rrousselGit/river_pod/tree/master/packages/riverpod You've answered that question. — paiv, Mar 22 '21 at 21:15

score 2 · Accepted Answer · answered Mar 22 '21 at 21:16

2

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)

answered Mar 22 '21 at 21:16

VonC

1,129,465
480
4,036
4,755

yep... worked! thank m8 (stack is forcing me to wait to assign you the bounty, I will as soon as I'm allowed) – Francesco Iapicca Mar 23 '21 at 10:55

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

1 Answers1