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 README #46

Open

JVSONV opened this issue Jun 13, 2023 · 0 comments

Assignees

Collaborator

JVSONV commented Jun 13, 2023

Create a README file for both your portfolio and each of your projects. This file should contain:

Project's Title
Project Description:
1. What your application does.
2. Why you used the technologies you used.
3. Some of the challenges you faced and features you hope to implement in the future.
How to Install and Run the Project
How to Use the Project.
Include Credits:

If you worked on the project as a team or an organization, list your collaborators/team members. You should also include links to their GitHub profiles and social media too.

Add a License:

For most README files, this is usually considered the last part. It lets other developers know what they can and cannot do with your project.

This information was sourced from FreeCodeCamp: How to write a good README file

JVSONV self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment