Upalr
Upalr

Reputation: 2148

How to create a README file inside a subdirectory on GitHub?

Is it possible to create a README file in a subdirectory on GitHub? I only see the Add a README button when I am in the root directory. It is not visible in subdirectories.

Is there any way I can add a README file in a subdirectory and preview it?

Upvotes: 6

Views: 17894

Answers (3)

Amrutham Mohan
Amrutham Mohan

Reputation: 46

To create a readme.md file for your profile in Git hub create a repository with your username and create a readme.md file and then https://rahuldkjain.github.io/gh-profile-readme-generator/ use this link to generate a content and then commit the changes it will reflect in your git hub repo

Upvotes: -1

Hamza Anis
Hamza Anis

Reputation: 2565

  1. Go to the directory directory browsing on GitHub.
  2. Create a new file GitHub file creation button
  3. Name it as README.md entering file name for a new file on GitHub
  4. Commit change
  5. You can see the README in the subdirectory Markdown preview of README.md on GitHub

Upvotes: 15

Michael Mior
Michael Mior

Reputation: 28752

There is no button to create a README on the GitHub web interface in any folder but the root. If you want to add a README to another folder, you can navigate to that folder and press the "Create new file" button. Just name the file README.md and you'll have the exact same editor available.

Upvotes: 4

Related Questions