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

Feedback on potential README improvements #12

Open
sabahzero opened this issue Aug 25, 2021 · 3 comments
Open

Feedback on potential README improvements #12

sabahzero opened this issue Aug 25, 2021 · 3 comments

Comments

@sabahzero
Copy link

As a new user, the README instructions came across as quite confusing to me. Here are some suggestions:

  • What is the purpose of wdsub, and what is the general mechanism by which it operates (detail)?
  • The installation and compilation is a bit unclear, ie using sbt vs docker
  • Usage and functions could be improved -- what do they do, how, and why?
  • Examples of README instructions that may be helpful: QIIME2 Metabolomics plug-in, Configuration instructions for our Applied Bioinformatics course (this was updated after feedback from students)
@labra
Copy link
Member

labra commented Aug 26, 2021

Thanks a lot for the feedback. We will update it as soon as possible.

Notice that the project is a proof of concept and the software is not production-ready. But nevertheless, we will try to improve it as soon as possible. I will keep the issue open until we improve the README.

@sabahzero
Copy link
Author

@labra no problem, I'm also happy to write up a suggested README as I work through it if that may be helpful

@labra
Copy link
Member

labra commented Sep 8, 2021

That would be great!

Thanks a lot for using wdsub. For some reason, I missed the github notifications about your issue trying to install wdsub and also this answer.

We have been working these days on a sister project to wdsub called sparkwdsub which can also be used to create wikidata subsets but follows a different approach based on Apache Spark which allows to create the subsets using ShEx based graph traversal.

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

2 participants