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

Update README.md #163

Open
benedeki opened this issue Feb 29, 2024 · 0 comments
Open

Update README.md #163

benedeki opened this issue Feb 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
Atum release 0.2

Comments

@benedeki
Copy link
Contributor

benedeki commented Feb 29, 2024 •
edited
Loading

Background

README.md is missing some crucial information

Feature

Add missing information into the README.md

Required

  • requirements for build
  • requirements for run
  • requirements for integration tests
  • TOC
  • Fix Atum is a data completeness tool

Optional

  • Badges for build, latest released versions per env. etc
@benedeki benedeki added the documentation Improvements or additions to documentation label Feb 29, 2024
@benedeki benedeki added this to the Next major Atum release milestone Feb 29, 2024
@benedeki benedeki moved this from 🆕 To groom to 📋 Backlog in CPS small repos project Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
CPS small repos project
Status: 📋 Backlog
Milestone
Atum release 0.2
Development

No branches or pull requests
1 participant
@benedeki