Welcome to the Treehouse Community

The Treehouse Community is a meeting place for developers, designers, and programmers of all backgrounds and skill levels to get support. Collaborate here on code errors or bugs that you need feedback on, or asking for an extra set of eyes on your latest project. Join thousands of Treehouse students and alumni in the community today. (Note: Only Treehouse students can comment or ask questions, but non-students are welcome to browse our conversations.)

Looking to learn something new?

Treehouse offers a seven day free trial for new students. Get access to thousands of hours of content and a supportive community. Start your free trial today.

Development Tools

Christian Zemke
Christian Zemke
2,653 Points

Didn't get the option for the README file.

When going through the Create a Repo video, I was following along and didn't get an option to have a README file. Now in this video the instructor is referring to that file after opening it in Atom. I have mine open but I don't have the README. I'm not sure if I possibly did something wrong in setup or if i'm using a newer version that changed up the usage. Looking forward to a response so that I can submit cool projects. Thanks in advance guys!

1 Answer

Jennifer Nordell
seal-mask
STAFF
.a{fill-rule:evenodd;}techdegree
Jennifer Nordell
Treehouse Teacher

Hi there! It shouldn't be a problem There are a couple of ways to fix this. I don't know exactly which video you're watching right now, but if you've created the repo on GitHub, you should be able to click on your repo (on the website) and if there are already files there, but no README, you should see a bluish box at the end of the list of files and on the right side a green button with "Add a README". This will open up a text editor and allow you to add a README directly from there. If you choose this option, you will then need to make a pull from your repo to get the README into your local system.

However, depending on where you are in your course it might be just as easy to manually add the README. To do this, just create a new file and name it "README.md". The extension stands for "markdown". Later, when you do a push up to your repo, the README will be uploaded to your repo.

Tip :bulb: You might have seen some really snazzy README files before and much like these forum questions and answers, they are formatted with markdown. Given that you might be showing your TD projects off to potential employers later, might I suggest an hour-long course here at Treehouse that will teach you how to do this? It's actually really fun and used in other places besides Treehouse and GitHub. Take a peek at Markdown Basics when you get a chance. :sparkles:

Christian Zemke
Christian Zemke
2,653 Points

Awesome! I found the option on the GitHub to create that file and followed your instructions to add it. And I will for sure check out that course you recommended. Thank you very much!