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

Mention and link SETUP.md on README.md #55

Open
miors opened this issue Jun 10, 2024 · 5 comments
Open

Mention and link SETUP.md on README.md #55

miors opened this issue Jun 10, 2024 · 5 comments
Assignees
Labels
Hacktoberfest Issues to solve during the online event Improvement New feature or request

Comments

@miors
Copy link

miors commented Jun 10, 2024

When someone first view a project on github, normally the README.md is their first port of call. For this project however, the README.md does not have setup instruction on it which is written on a separate file SETUP.md. Would be beneficial to link SETUP.md from within README.md

@berkingurcan
Copy link
Collaborator

Yes, absolutely! I will reorganize the readme.

@CristinaEche CristinaEche added Improvement New feature or request Hacktoberfest Issues to solve during the online event labels Sep 29, 2024
@GbotemiB
Copy link

GbotemiB commented Oct 3, 2024

Hello @miors ,

I see that this doesnt seem to have been completed. Is it ok for me to go ahead and work on this?

@berkingurcan
Copy link
Collaborator

@GbotemiB Hello, you can work on this!

@CristinaEche
Copy link
Collaborator

@berkingurcan @GbotemiB Do we have any updates on this?

@GbotemiB
Copy link

GbotemiB commented Nov 4, 2024

Hi @CristinaEche, The update was to reorganize the readme, which i already created a PR for. I am awaiting review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest Issues to solve during the online event Improvement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants