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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

We need a README! 馃帀 #1

Open
Chovin opened this issue Sep 24, 2021 · 1 comment
Open

We need a README! 馃帀 #1

Chovin opened this issue Sep 24, 2021 · 1 comment

Comments

@Chovin
Copy link
Contributor

Chovin commented Sep 24, 2021

A What?

a readme acts as a project's front page to users as well as devs. If you've taken a look at other Github repos (projects) before, you've probably seen them displayed right under the file list!

like this one from Clairvoyant

What goes into one?

There's a really good guide on what works well in READMEs at makeareadme.com.

Examples

There's a bunch of awesome READMEs listed here that are worth a gander at!

@raihan71
Copy link

raihan71 commented Oct 4, 2021

hey i can work with this @Chovin assign me plz

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

No branches or pull requests

2 participants