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

Huge lack of information on this repository #21

Open
Kalyan3578 opened this issue Oct 31, 2018 · 0 comments
Open

Huge lack of information on this repository #21

Kalyan3578 opened this issue Oct 31, 2018 · 0 comments

Comments

@Kalyan3578
Copy link

This repository is uninformative & is lacking hugely on specifications, installation/setting up guides, emphasizing dependencies etc. A short one-line description of the program on the README.md is surely not enough considering OpenPub does not have a Wiki page. This issue needs to be solved as quick as possible so it can drag more users in as it does have quite as interesting idea.

Many users will fail to know or to understand what OpenPub can mean seeing this repository for the first time. It's loss for the repository.

Please add all the necessary elements and sections to README.md file and consider creating a unique and brief Wiki page for OpenPub.

Few sections that can be added:

  • Fair description on OpenPub
  • Setting up guide for all platforms separately
  • Installation guide going step by step explaining all dependencies
  • Alternative and manual methods of accessing OpenPub
  • Logo design
  • Wiki page consisting of lengthy paragraphs describing every element on OpenPub
  • Revealing ideas of how OpenPub came to be

There's also a missing CONTRIBUTORS.md file in this repository which is primarily present in almost all repositories for users to add their name to the contributors list, consider adding it.

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

No branches or pull requests

1 participant