Create separate Readme for Github

[novellac]

Context

Right now, Vuepress uses README.md as its homepage. This means that when we visit Github, we see the same content as on the workshops homepage. We want to have these separate, so that users who go to github can be introduced to the repository and how to contribute.

Expected Behavior

I expect to see a different README presented on Github, versus on the workshops homepage.

Acceptance criteria

The workshops homepage should contain different information than the Github readme.

Additional information

There was a PR to allow Vuepress to use index.md instead of readme.md. However, this PR does not seem to work in practice. In the comments on the PR, one person presents a workaround, which we will try here (using readme.markdown in the hopes that Github will prefer it over readme.md).

[MicheleCynowicz]

@novellac, I've merged PR #153 into the dev branch and tested it locally - it WORKS! 🎉

Do you want to take up the job of writing out our GitHub README instructions?

[novellac]

Yup! I'll create a PR for that in the next day or so if there is not one already.

On Mon, Aug 3, 2020, 19:45 MicheleCynowicz notifications@github.com wrote:

@novellac https://github.com/novellac, I've merged PR #153 https://github.com/FrontEndFoxes/docs/pull/153 into the dev branch and tested it locally - it WORKS! 🎉

Do you want to take up the job of writing out our GitHub README instructions?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/FrontEndFoxes/docs/issues/152#issuecomment-668294063, or unsubscribe https://github.com/notifications/unsubscribe-auth/AJC2ETLUCBN4TL7E5AAK6ELR65D3FANCNFSM4OQMOGAQ .

[jlooper]

This would be a nice feature to have when completed. thanks!