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

Exercise 1: Eat Me, Drink Me 📚 #2

Open
1 task
SallyMcGrath opened this issue Dec 15, 2024 · 4 comments
Open
1 task

Exercise 1: Eat Me, Drink Me 📚 #2

SallyMcGrath opened this issue Dec 15, 2024 · 4 comments
Labels
🔑 Priority Key Do this first 🦔 Size Tiny Less than 30 minutes 🎯 Topic Requirements Interpreting requirements with precision and accuracy

Comments

@SallyMcGrath
Copy link
Member

The first thing you should always do is find and read the README

Find the README file in this repository
What is its purpose? How can you tell?

You've completed this ticket when...

  • You can explain in one sentence what a README file does
@davidbrown2324
Copy link

We can explain why the README.md file does.

"The README file is a summary and introduction to the project in the repo".

@sul-devs
Copy link

A readme file explains your project to visitors to your repo. It is the first impression people have of your project, and can help people learn more about it.

@Rawan-Al0-0
Copy link

Rawan-Al0-0 commented Jan 11, 2025

A README file is a file that includes all the instructions required to complete a task or a project.

@SabitaShrestha325
Copy link

Readme file is to explain about project, make other developer to understand what is done and need to do and make easier to instructed about it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔑 Priority Key Do this first 🦔 Size Tiny Less than 30 minutes 🎯 Topic Requirements Interpreting requirements with precision and accuracy
Projects
Development

No branches or pull requests

5 participants