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

Add proper README #11

Closed

otsob opened this issue Nov 17, 2018 · 0 comments

Assignees

Owner

otsob commented Nov 17, 2018 •

edited

Loading

In order to use or collaborate to wmn4j,
as a user/collaborator,
I want there to be a descriptive README.

Acceptance criteria:

There is a section on the purpose of the project
There is an overview of the structure of the project
There is a link to API documentation
There is is a section on building the project
There is a section on how to contribute to the project
There is a code of conduct

otsob changed the title ~~Add architecture description to README~~ Add proper README

otsob self-assigned this

otsob closed this as completed

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