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

Outdated readmes in mano-framework #14

Open
bjoluc opened this issue Apr 28, 2020 · 0 comments
Open

Outdated readmes in mano-framework #14

bjoluc opened this issue Apr 28, 2020 · 0 comments

Comments

@bjoluc
Copy link
Collaborator

bjoluc commented Apr 28, 2020

The Readme files for the mano-framework components are outdated, now that we use Docker Compose for the builds and Poetry for project and dependency management. Since they all share the same setup which is also described in the "Developing Pishahang" docs, none of them needs extra information on:

  • How to run builds
  • How to run unit tests
  • Requirements (unless they need anything fancy of course)
  • Implementation (at least programming language and dependencies)

Apart from that, it looks like this readme is a copy of this one.

I would suggest to have only a description of each microservice's in its readme, so that we can include all of them in the developer documentation.

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

1 participant