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

Improve README #19

Open
Shinigami92 opened this issue Jul 23, 2020 · 0 comments
Open

Improve README #19

Shinigami92 opened this issue Jul 23, 2020 · 0 comments
Assignees
@Shinigami92

Comments

@Shinigami92
Copy link
Contributor

Shinigami92 commented Jul 23, 2020 •
edited
Loading

Improve README

Summary

We should greatly improve README.md (at least in core)

Motivation

A big and usefull README.md can improve the first contact with customers.

Detailed Design

We should add updated badges, a logo (see #7), installation guide, ...

Documentation

This is the reduced form of a documentation 🙂

Drawbacks

No.

Alternatives

No.

Open Questions

Any questions?

Help Needed

Yes, we should think/work together on creating an improved README.md.

Frequently Asked Questions

Currently none

Related Discussions

Currently none
This was referenced Jul 23, 2020
Open
Closed
@Shinigami92 Shinigami92 self-assigned this Jul 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Shinigami92 Shinigami92

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Shinigami92