What is the README?
A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about.
Why should I make it?
It's an easy way to answer questions that your audience will likely have regarding how to install and use your project and also how to collaborate with you.Who should make it?
Anyone who is working on a programming project, especially if you want others to use it or contribute.When should I make it?
Definitely before you show a project to other people or make it public. You might want to get into the habit of making it the first file you create in a new project.Where should I put it?
In the top level directory of the project. This is where someone who is new to your project will start out. Code hosting services such as GitHub, Bitbucket, and GitLab will also look for your README and display it along with the list of files and directories in your project.How should I make it?
While READMEs can be written in any text file format, the most common one that is used nowadays is Markdown. It allows you to add some lightweight formatting.
What is Markdown?
Markdown is a markup language just like HTML, allowing you to format your online content in plain text. While some prefer to use it in order to publish content with the .md or .markdown output, others prefer it purely for the writing experience it offers.Users with a tech background tend to love the smooth writing experience it offers, as it allows both writing and formatting to flow in a similar way as the coding way. However, not everyone is used to or fond of this experience.
This is because learning Markdown from scratch is not easy, and this is especially true if you have never coded before. Not only do you have to learn formatting with syntax, but you also have to learn a whole new writing experience. This usually requires a big change in one's writing habits.
Create an amazing Github profile in minutes.
This is a web application that has been built using HTML, CSS and JavaScript and has been developed using React framework.
This is part of our university student projects, and it can be said that it is one of our first group assignments. We know that the application is not perfect and many more things need to be added, but we hope to make it more complete in the future.
The entire site uses responsive design and runs correctly on any device of any size. Accessing the site is very easy, just use the table below.
| Access the Site | Try |
|---|---|
| Link | Click Here |
| QR Code |  |
The web application is made of three main parts:
- Document.
- Create Readme for my Project.
- Create Protfolio.
- Repository name.
- Explanations about the repository.
- Demo version of the repository.
- License.
- Repository.
- How to install and use the repository.
- The name and surname of the programmer.
- Programming skills.
- Programmer work experience.
- Ways to contact the developer.
Also, this section has a number of graphs to analyze each person's GitHub account. These graphs show the amount of coding each person has done throughout the year. It also shows the language in which each person has written their codes and displays information such as the number of visits to the account. It also shows the number of received stars in this section.
Note: You need Node.js to install this program.
Click to download Node.js.
git clone https://github.com/mammaddrik/readmehub.git
cd readmehub
npm i or npm install
npm start
Note: It may take a long time to install the program and its required packages, so be patient until it is fully installed
readmehub is licensed under MIT License.