Create projects on GitHub like a Pro!
Original Source Here
Different Sections regarding Documentation
The number and types of sections will differ from person to person. In this article, I will share the sections which I use and will be beneficial for everyone. The documentation is done on the README.md file.
1. Project Title, and a short description of the project.
For kicking things off, we need to have a title to our project. A project without its title is like a book without its title. To follow that, a 2–3 lines description of our project. As an example, I’ll be showing my project, CROPify to give you a more clear understanding:
2. Motivation and purpose of the project.
The motivation of a project is paramount, as it lets the recruiter/people know your purpose for creating the said project. In this example, I have listed down why I created CROPify:
3. Tech Stack and Resources used.
“Tech Stack” basically means the different technologies you have used for making your project. In my case, I use technologies like Flask, Sklearn etc. You can just list them, or you could put their logos directly. This approach looks better in your documentation.
“Resources” here mean the files you have used for making your project. As for me, I was working on a Data-Science project. So I had to use a dataset for model creation. That is why I put the link from where I got my dataset:
4. Algorithms/ Concepts used:
The basis of every project is a concept/ algorithm. We have to let our viewers know what algorithms we are using for our project, for them to understand our project in a profound manner.
If you are using a lot of algorithms, you could show them in a bar chart, according to their accuracy, R2 score, etc. This will help the viewers to understand the reason why you went with a specific algorithm.
5. Features Used:
Features are basically the parameters that go in your project, which give them functionality. For example in CROPify, I have created a web application, that would take different parameters like Nitrogen level, Phosphorus level, temperature etc, and the application would be able to predict what crop to grow in the respective field.
In this scenario, nitrogen level, phosphorus level act as different inputs to my application. This might be different for other projects, so you need to put the features that you think are important.
6. Functionality of the Project:
As the name suggests, in this section, you need to show/tell the basic functionality for your project. In CROPify, the functionality was that farmers would find out which crop they can cultivate, with added benefits like knowing the sowing and harvesting dates etc.
If a person wants to download and run your project locally, he needs to be able to do that. For this reason, I put a few steps, so that anyone could start working/using the project ASAP.
7. Screenshots/ Demo Video:
In this section, you need to put some screenshots of the project. This is done for people to take a look at the application without opening it.
The demo video must be in .gif format, as it takes less space and is faster than a normal video.
8. Issues and Future Improvements:
Issues are the problems that you are currently facing in the project, and future improvements are the improvements that you wish to add the future to your project.
These are very important, as it opens a potential way for people to contribute.
AI/ML
Trending AI/ML Article Identified & Digested via Granola by Ramsey Elbasheer; a Machine-Driven RSS Bot
via WordPress https://ramseyelbasheer.io/2021/06/01/create-projects-on-github-like-a-pro/
