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

Restructure README files #18

Open
1 task
oleschwen opened this issue Oct 24, 2024 · 3 comments
Open
1 task

Restructure README files #18

oleschwen opened this issue Oct 24, 2024 · 3 comments

Comments

@oleschwen
Copy link
Collaborator

Having created multiple application codes, the different README files have become somewhat redundant. Plus, some documentation is aimed at developers, some is for client nodes, some is for both.

AC:

  • well-structured README.md files, linking to each other and to further instructions, for the existing application code and different target groups
@oleschwen
Copy link
Collaborator Author

This issue addresses part of #2 and follows #11 and #14.

@oleschwen
Copy link
Collaborator Author

I'll prepare a suggestion for how to structure these with a trade-off of having little redundancy and looking at few places.

@oleschwen
Copy link
Collaborator Author

Discussed in call 2024-10-28: for the time being, use a single README.md, we can split it once we roll MediSwarm out to a non-developing user site and see which information is relevant for them.

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

No branches or pull requests

1 participant