Basic overview for creating a stellar README file
Published: 2024-02-12 03:07:37

When you create projects that you want to show to other people you should get in the practice of creating an overview that tells people about your application, what it does, how you use it and other important information people should know before exploring your repo. The README file is typically the first thing other developers will look at when they first enter your application. Giving a good impression off your README is a great way to get other developers engaged in your project!
<img width="100%" style="width:100%" src="https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExNXR4bXI1dzZ4cTF6MzI3cXlwaXZlN3d5MXFjaG9hcnNoanZyeWs0OSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/xUA7b2OfgTuVzqpVXq/giphy.gif">



##**Getting Started**
First, you want to think about why you created your application. What problem does it solve? What is the purpose of it? What does the application do?

Next, it's a good idea to use [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax to style your README. It allows you to easily format your README to make it visually easier to read and catch the readers eye more easily. It also will help in making your README look really good when it's opened in a browser window.

Once you have an idea of your "why" for the application, it makes writing the README much easier. 

##**Structure**

1. Title
2. Authors 
3. Description
4. Setup/install 
5. Table of Contents
6. Licenses
7. Extras

## Title
Include the title of your project. Give it a name that is indicative of the project. You can also add a sub-heading to add any additional information in your title.

##Authors
Pretty easy. Who wrote the program? Include the names of everyone who worked on the project.

##Description
Give a brief description of your application. 3-5 sentences is generally enough. Most of the time people are just scanning the information to get a general idea. You can take it up a notch by adding some images of the application or any diagrams you think would be helpful to include. But keeping it relatively short is ideal.  

##Setup and Installation 
Another top key feature to include in your README is giving the commands you need to run the application. Inform the reader of the packages and other technologies they'll need to install and start to get the application running. For example, if you were doing a README for a React/Python application, the set up instructions might look like:

```
pipenv install
pipenv shell
npm install --prefix client

python server/app.py

npm start --prefix client

```

##Table of Contents
Although you want to keep your README relatively short and simple, sometimes they can get kind of lengthy. So, some people opt to include a table of contents under the title of their README. These are optional and won't make your README any less substantial if you choose not to include one. 

##Licenses
When you are working on a project and you want to protect your intellectual property you can get a license to include in your README. There are different type of licenses you can get based on whether you want to have your application be an open-sourced project - where other people can fork your repository and make changes to your project. Having a license will allow you to keep that copyright and tell developers what they can and can't change in your project. Here are a couple of links to some licensing websites to guide you. 
[ChooseALicense](https://choosealicense.com/)
[Open Source Initiative](https://opensource.org/licenses/)

##Extras
There are some extra elements you can include in your README to take it the extra mile. Some popular ones are things like including any tests you have implemented. Creating your own tests is a really good way to show off your skills as a coder and really takes your skill set up a notch. 
Another big one is including [badges](https://naereen.github.io/badges/). Don't go overboard on the amount of badges you use as it can be distracting from the point. But including some in your README can be a really good way for anyone who reads it to take quick notes of what's going on in your application.

## **Conclusion**
I hope these tips and links I included help give you a template of how to write a profound and informative README that will impress anyone who sees your project. As always, happy coding!

SOURCES
[archbee.com](https://www.archbee.com/blog/readme-document-elements)
[GitHubDocs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
[FreeCodeCamp](https://www.freecodecamp.org/news/how-to-write-a-good-readme-file/)