Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a README file for better project understanding. #116

Open
Surajpatra700 opened this issue Jan 17, 2024 · 3 comments
Open

Add a README file for better project understanding. #116

Surajpatra700 opened this issue Jan 17, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Surajpatra700
Copy link

Surajpatra700 commented Jan 17, 2024

Currently, this repository lacks a README file, which is crucial for providing clear guidance and context to potential users and contributors. Having a README would significantly enhance the project's accessibility and usability.

@Surajpatra700
Copy link
Author

I will take the initiative to draft a comprehensive README, covering key aspects such as project overview, features, key components, usage instructions, and contribution guidelines. I'm eager to contribute this content to the repository to make it more approachable for everyone.

@OscarMrZ
Copy link
Collaborator

Hi @Surajpatra700, are you still working in this issue? I see there is now a good readme :D

@OscarMrZ OscarMrZ added the documentation Improvements or additions to documentation label Feb 15, 2024
@jmplaza
Copy link
Member

jmplaza commented Feb 15, 2024

BTW the RAM license should be GPL v3 (instead of MIT) in the README

@OscarMrZ OscarMrZ added the good first issue Good for newcomers label Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants