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

Improve readme #247

Merged
merged 13 commits into from
Feb 26, 2024
Merged

Improve readme #247

merged 13 commits into from
Feb 26, 2024

Conversation

Samuwhale
Copy link
Collaborator

This aims to solve #241.

I have rewritten and scrapped a lot, adding links to the docs where information has been removed.

Please let me know if this is too concise, or if it could be even shorter.

I am still doubting about the 'feature' list, and what features to add or remove - or the wording on specific features. So feel free to give input on that section.

@Samuwhale Samuwhale requested a review from qubixes February 3, 2024 11:01
@qubixes
Copy link
Member

qubixes commented Feb 14, 2024

Thanks @Samuwhale, I think it's turning in the right direction. I still think the README reads a little bit on the sluggish side, but I think it's also good to wait on @vankesteren to see his perspective. I'm trying to think in which order I would want the information to be presented. I think it also depends a bit on which perspective you take (data provider or researcher). I'm taking the perspective of a researcher, also because I think they probably need the most help/attraction to get them started.

  • What is metasyn? -> Safe and understandable synthetic data for your privacy sensitive datasets. Maybe some bullet points on what makes metasyn good/different from other synthetic data packages.
  • How can I create a synthetic dataset? -> Tutorials, examples (even the GMF stuff might be too much here even though it's one of the main features of the package).
  • I'm convinced, I want to install it! -> Installation instructions
  • I'm interested in more details, information, want to contribute, have questions -> Contributions, guidelines, link to documentation, maybe a little bit on the GMF idea and why it's cool here.

Samuwhale and others added 4 commits February 26, 2024 09:57
@vankesteren vankesteren merged commit f6960cf into main Feb 26, 2024
6 of 7 checks passed
@vankesteren vankesteren deleted the improve-readme branch February 26, 2024 16:01
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

Successfully merging this pull request may close these issues.

None yet

3 participants