Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Writing a more descriptive README.md and other related files to get started #781

Closed
salilmishra23 opened this issue Feb 19, 2019 · 1 comment
Labels
documentation Modifies the documentation.
Milestone

Comments

@salilmishra23
Copy link

I think having a descriptive README.md allows a new user to get most of the important details in one go.
We do provide this information in the docs(https://juliaimages.org/latest/install.html) but having it here would also be good.

I also propose a CONTRIBUTING.md file describing how can one start making a contribution to the package. It provides beginners a path to follow and makes their journey to their first contribution easier.

@johnnychen94
Copy link
Member

  • The docs(https://juliaimages.org/latest/install.html) is the documentation of the whole Julia Image ecosystem.
  • This repository Images.jl, however, consists of many dependencies. It would be quite ambiguous to introduce too many details of other repos to Images.jl/README -- which part of it really belongs to this repo?

But yes efforts should be paid to make the documentation more descriptive:

  • we can add some quick-to-start snippets in Images.jl/README.
  • Perhaps adding some comparison (code simplicity, benchmark, etc.) to other languages will make this package more attractive. But I think this packages is not mature enough to do this right now.
  • Also, I think there are few description to the relationship of this ecosystem at present.

@johnnychen94 johnnychen94 added the documentation Modifies the documentation. label Jan 1, 2020
@johnnychen94 johnnychen94 added this to the v1.0 milestone Jan 1, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Modifies the documentation.
Projects
None yet
Development

No branches or pull requests

2 participants