[DOCS] : Providing Proper Installation File and Documentation

Arbtrage commented 11 months ago

Overview

The current project configuration presents complexities for installation and setup. To streamline this process and make it more accessible for contributors, we need to provide a proper installation file along with comprehensive documentation.

Goals

Create an installation guide that simplifies the setup process.
Develop a clear and concise documentation to aid contributors in configuring the project environment.

Tasks

[ ] Draft an installation file (e.g., INSTALL.md) outlining step-by-step instructions for setting up the project.
[ ] Create comprehensive documentation covering various aspects of configuration.
[ ] Include troubleshooting tips and common issues resolution in the documentation.
[ ] Ensure the documentation is written in a clear and understandable manner for contributors of all levels.

Additional Information

This improvement will significantly enhance the onboarding experience for contributors, enabling them to easily set up the project environment and start contributing efficiently.

Your contributions and suggestions towards achieving this goal are highly appreciated! Feel free to collaborate and provide insights or assistance in this endeavor.

ShatilKhan commented 11 months ago

I'd also like to take this one @Arbtrage

Rani1303 commented 10 months ago

Hey @Arbtrage I would like to work on this issue.

Arbtrage commented 10 months ago

Sure , @Rani1303 .

Arbtrage / Enigma