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.

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 a README #34

Open
Abe404 opened this issue Jun 3, 2021 · 1 comment
Open

Create a README #34

Abe404 opened this issue Jun 3, 2021 · 1 comment

Comments

@Abe404
Copy link
Collaborator

Abe404 commented Jun 3, 2021 •
edited
Loading

When new developers arrive at this project they currently see the readme which states 'ml-image-wiki' without further detail.

A standard way to communicate project details is to write a README.

General advice for writing a README is available here:
https://www.makeareadme.com

It's not a typical software project but questions we might want to answer in a wiki are:

What is the aim/goal of this project?
Who is the project for?
How is it deployed?
How to make changes / contribute?
What is the role of 'issues' in the project?

This will likely help with faster onboarding of new developers / contributors.
@Abe404
Copy link
Collaborator Author

Abe404 commented Jun 3, 2021

After we get the README sorted, the next step is to add a short description in the 'about' text (seen top right)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Abe404