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

Improve README with details and diagrams #3

Open
danmohad opened this issue Jul 23, 2023 · 0 comments
Open

Improve README with details and diagrams #3

danmohad opened this issue Jul 23, 2023 · 0 comments
Assignees
@danmohad
Labels
documentation Improvements or additions to documentation

Comments

@danmohad
Copy link
Owner

In README.md:

  • Add a UML diagram to describe the program
  • Add details regarding how the code works and how to run it (with and without Docker)
@danmohad danmohad added the documentation Improvements or additions to documentation label Jul 23, 2023
@danmohad danmohad self-assigned this Jul 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danmohad danmohad

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@danmohad