What is a README file?
The readme file is the first thing a user will see when viewing your repository. It gives the user an idea of wha...
For further actions, you may consider blocking this person and/or reporting abuse
Great post and a great recommended structure.
There are more potential audiences for a Readme file, not just potential employers.
Of course, thanks for adding potential audiences, Brian. 🙏
Since I am mostly focussing on career switchers and CodeNewbies in my blog posts, I didn't think about others than future employers.
I'm curious why some projects include super-detailed installation instructions and in how much details I should explain mine. Some projects explain how to download git, clone the project, download the IDE, what buttons to click in the IDE, etc.
I think, if a recruiter or a client opens your GitHub project, they won't build it, and instead just follow a link to the running version / download the installation package, will they? On the other hand, if a developer wants to build your project, they already know how to do that. Do I miss something here?
Thanks for your comment.
Yes, for recruiters a link to the deployed version is indeed the best option, as I mentioned in the article.
I do not agree though for the developer part. A local setup can be soooo different. Some are using docker or kubernetes, some specific npm version, some require local server running or db connection, how to start the app can also differ. As a dev I am not only interested in a project with the language I know best but maybe want to learn something new as well.
Thank you Julia for the post... It's great!
I use to add the images with the following syntax:
<img src="./public/screenshot.gif" width="50%" height="auto" alt="Screenshot">
In case anyone can use it. 😉
A big hug from Venezuela.
Thanks for sharing, Francisco!
this is from a perspective that no regular developer will user. I would avoid at all cost images, why? because if you have them from an url they will not remain in that url for much and adding them to the repo is not the greatest of ideas 'cause you'll end up adding unnecessary weight to the repo.
Beyond that I'll add the how to run the repo probably after the description 'cause usually there's not a lot of steps and a couple of terminal commands will be enough. Otherwise I think is a great way to have really useful readme files
Thanks for sharing your insights, Rodrigo.
Graet and usefull post. It let me think if my Readme is any good. Maybe you could let me know.
github.com/The-R4V3N/Team_project_...
I think it is, @ther4v3n . I would remove the personal part inside the project's readme, this is something which should be added to the readme of your GitHub profile (which I saw you already have) :)
Thank you!
Thank you for this article. Now I have a guide on when I need to create a readme
Glad it helped, Vicente.
I’m a newbie coder and am currently learning how to make a README file, so this was awesome to see when I first opened the app!
Glad it helps, @alyssawink And a warm welcome to the tech community :)
Thank you! I’m excited to start!
everything ingenious is simple!
Great post, thanks for sharing 🙃
Thank you, Travis.
Fantastic guide on crafting an effective README.md file! Your seasoned advice and structure tips showcase your expertise. Gratitude for sharing these invaluable insights.
If the target media isn't paper, I'd advocate against underscored text for emphasis, because it's widely understood as links and therefore could be misleading.
This is awesome.
Thank you for sharing !!
Amazing read! This is so useful. 👏
Great post! Creating a default structure is good for keeping consistency across all projects! Thanks!!
When posting on GitHub, do not forget you can also fill in the about section of your project on the right side. Here you can give a brief summary of your project and can complement the readme a bit.
If you fully understand Markdown and related stuffs you cannot be stuck while using writing a good README.md file!
Happy Coding!
It depends strongly of the target. As developer, the first expected area will probably be "Install", next "How to" with clear and concise code examples ;-)
Nice!!, thanks for sharing this
You are welcome, thanks for your comment.
Nice article @yuridevat , thanks for sharing it! 👌
Thanks Ricardo.
This article couldn't have come at a better time for me. It addressed exactly what I needed to know, and I'm grateful for your insights.
Thanks for your comment, Alex. Glad that it helps 😊
Thanks for sharing💖
You're welcome 😉
Nice post, proper structure of README can ease user and builders efforts to understand a project.
Thanks Astrodevil.
great!
Great blog post.
Suggestion -
Get the hands-on experience with the visual look and feel based mark down editor? use the below options.
That was amazing 😍