CODEWITHSUNDEEP
webgithubweb-hosting
John Anchery
John Anchery

Reputation: 73

Can I use README files in github pages

I am working on a website to host on github, and I want to add README.md file, to let people know what exactly is it.

So is it ok to do that, would that end up in error

Upvotes: 0

Views: 65

Answers (1)

serraosays
serraosays

Reputation: 7889

Yes, you can add a readme.md file to any Github repo. Github offers extensive documentation on how this works.

If I read into your question more deeply, I think what you're really asking is that if you add a readme to a project being hosted on Github pages - will that effect how the hosted website is presented? The answer would be no. In this case, read about how Github pages hosting works.

Upvotes: 1

Related Questions