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.

Sign up for GitHub

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

Jump to bottom

Create an in-depth documentation for the README.md file #54

Open
kenny-io opened this issue Jul 29, 2024 · 5 comments
Open

Create an in-depth documentation for the README.md file #54

kenny-io opened this issue Jul 29, 2024 · 5 comments
Labels
good first issue Good for newcomers

Comments

@kenny-io
Copy link

Update the READM file in this repository to be more in-depth and cover the project in more detail.

A potential table of content for the file could look like:

  • Overview of the project
  • How to get started or local setup instruction
  • Call out any specific configs or files that is a must-know for contributors
  • How to contribute to the project, any special instructions
@kenny-io kenny-io added the good first issue Good for newcomers label Jul 29, 2024
@rembertdesigns
Copy link

I would like to assist with this

@kenny-io
Copy link
Author

kenny-io commented Aug 5, 2024

I would like to assist with this

@rembertdesigns go for it! 💪🏽

@Tim00x
Copy link

Tim00x commented Aug 16, 2024

@kenny-io , can I take this up?

@kenny-io
Copy link
Author

@kenny-io , can I take this up?

@Etimfon007 Yes, go for it and let us know here if you need help with anything

@Tim00x
Copy link

Tim00x commented Aug 16, 2024

Alright then. If I need any help I'll let you know @kenny-io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kenny-io @rembertdesigns @Tim00x