[DOCS] : Updating Outdated README

Arbtrage commented 8 months ago

Overview

The README file in our repository requires an update as it's outdated and doesn't reflect the current state of the project. A refreshed README will better inform visitors and potential contributors about the project, its functionalities, and how to get started.

Goals

Revise and update the existing README to accurately represent the project's current status and features.
Ensure clarity and completeness in describing the project, its purpose, usage, installation steps, and any other relevant information.
Incorporate any recent changes or updates that have occurred in the project.

Tasks

[ ] Review the current README file and identify outdated or missing information.
[ ] Ensure the README is structured, concise, and easy to understand for newcomers.
[ ] Include information about how to contribute, code guidelines, and any essential project-related details.
[ ] Request feedback from team members and stakeholders to ensure the accuracy and completeness of the updated README.

Additional Information

An up-to-date README is crucial for providing a clear understanding of our project to both new users and potential contributors. Contributions and suggestions for improving the README are highly encouraged!

ShatilKhan commented 8 months ago

Hi I'd like to work on this issue Please assign @Arbtrage

subhasou26 commented 8 months ago

Hello I want to work with the issue under SWOC 2024. Could you assign the issue to me?

Arbtrage commented 8 months ago

Hey @ShatilKhan , will you be working on this issue ?

ShatilKhan commented 8 months ago

yup

On Mon, Jan 1, 2024, 3:52 PM Sayantan @.***> wrote:

Hey @ShatilKhan https://github.com/ShatilKhan , will you be working on this issue ?

— Reply to this email directly, view it on GitHub https://github.com/Arbtrage/Enigma/issues/4#issuecomment-1873251994, or unsubscribe https://github.com/notifications/unsubscribe-auth/AMQQD6E5GT5MTWWLEQPYFTTYMKBN7AVCNFSM6AAAAABBFMVEVWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNZTGI2TCOJZGQ . You are receiving this because you were mentioned.Message ID: @.***>

Arbtrage commented 8 months ago

Okay , here you go @ShatilKhan .

Arbtrage commented 8 months ago

Hey @ShatilKhan , any updates ?

ShatilKhan commented 8 months ago

About to make PR today

Arbtrage / Enigma