Enhance README file

[vikman90]

This issue proposes an improved structure for the project's README file to enhance clarity, usability, and professionalism.

Sections for the README

1. Project Title

   • A clear and concise title that represents the project.

2. Introduction

   • Brief description of what the project does and its purpose.
   • Key features or highlights.

3. Table of Contents

   • Links to different sections of the README for easy navigation.

4. Installation

   • Step-by-step instructions on how to install and set up the project.
   • Prerequisites and dependencies.

5. Usage

   • Detailed guide on how to use the project.
   • Examples and screenshots (if applicable).

6. Contributing

   • Guidelines for contributing to the project.
   • Code of conduct.

7. License

   • Information about the project's license.

8. Contact

   • Ways to get in touch with the project maintainers or contributors.
   • Link to the project's issue tracker.

9. Acknowledgements

   • Credits to contributors, third-party libraries, or any other acknowledgements.

Next Steps

• Review and approve the proposed README structure.

[vikman90]

Regarding the licensing, it is important to note that our project is currently under the AGPL 3.0 license. However, we need to investigate the compatibility of this license with GPL 2.0 and other dependencies we plan to use. Ensuring that all licenses are compatible is crucial for the integrity and legal compliance of our project.

[vikman90]

Work update

• Changed the heading notice.
• Section structure.
• Capabilities.
• Copyright and license notice.

[vikman90]

Work update

• 3rd party software filled up.
• Added Table of Contents.
• Draft PR: Update README.md file #165

[vikman90]

Work Update

• Removed Capabilities section.
• Updated 3rd Party Software.
• PR ready for review.