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.md file at root #21

Open
MathPow opened this issue Apr 21, 2024 · 4 comments
Open

Add a README.md file at root #21

MathPow opened this issue Apr 21, 2024 · 4 comments

Comments

@MathPow
Copy link

MathPow commented Apr 21, 2024

I am a new contributors and it would be nice to others new newcomers if they could can quickly understand the project and get started without needing to ask questions or search through code.

I think it is a key tool for a project like this. Maybe someone is already working on this, but I didn't found it in my quick tour.

Thanks!

@NatanaelBorges
Copy link

I'm also in agreement that this approach is well-aligned. There's already an open PR for the README template, providing an opportunity to include vital information for new contributors like project setup instructions, etc. Please feel free to contribute as well, your input would be greatly valued.

@MathPow
Copy link
Author

MathPow commented Apr 23, 2024

I am not able to start contributing. I can't seem to be able to run the project. I am new to this structure and I need some guidance.

@SamZie001
Copy link

I am not able to start contributing. I can't seem to be able to run the project. I am new to this structure and I need some guidance.

Hello, what part are you finding difficult to setup and run the application?

@ZachLTech
Copy link

there's no .env sample file (I'm not sure what .env variables are necessary)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants