Add a readme?

Question

Add a readme?

Aditya94A opened this issue 7 years ago · 7 comments

Add a readme?

Answer 1 · 2017-10-16T17:19:19.000Z

You can actually now just create an index.md:
https://github.com/blog/2289-publishing-with-github-pages-now-as-easy-as-1-2-3

Answer 2 · 2017-10-16T17:19:39.000Z

IDK if a symlink from README.md to index.md works or not?

Answer 3 · 2017-10-16T23:04:11.000Z

symlink index.html -> readme.md?

Answer 4 · 2017-10-17T00:05:34.000Z

On Monday, October 16, 2017, Michael Woolweaver ***@***.***> wrote: symlink index.html -> readme.md?

That would show HTML source in the project description? Or raw markdown as index.html? To be clear, one markdown document (and optional Jekyll theme) could work instead of both a README and an index.html (because of new-ish GitHub pages features): As it turns out, these symlinks aren't necessary because GitHub Pages will generate the index.html from README.md or index.md (on push; when there's not a `.nojekyll` file): ``` ln -s index.md README.md # or ln -s README.md index.md ``` With e.g. CloudFlare DNS, you can put HTTPS and HTTP STS on a custom domain in front of a GitHub Pages site; and have two CDNs for your README.md.

…

— You are receiving this because you commented. Reply to this email directly, view it on GitHub <#17 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AADGy64yiChirjvmnRov7U262eEEOtIpks5ss-DugaJpZM4P69Nd> .

Answer 5 · 2017-10-17T08:37:04.000Z

Here you go: https://krackattacks.now.sh

Answer 6 · 2017-10-17T10:09:28.000Z

And just found the website. Removing... 😊

Answer 7 · 2017-11-09T18:23:18.000Z

Now the README should be a tad more fancy, and hopefully it's clear to just visit the website at https://www.krackattacks.com