Docker file for UML Java + Shell script to add UML diagram to README

[Harsh290803]

• Docker file to install the dependencies and run the commands to generate UML diagram for Java projects.
  • Note that the java source files must be in ./uml_java/source_directory/ for this to work.
• Shell script (add_uml_to_markdown.sh) for appending the generated UML diagram to README.md of user's project.
  • Run the following command (note: image file path must be relative to the project directory path)

    bash add_uml_to_markdown.sh <project-directory-path> <image-file-path>

  • The above command will add the image to README.md in the project directory.

[linear[bot]]

CS3-82 Show UML diagrams in Markdown

* Show the generated UML diagrams for Python / Java projects in Markdown * Assume you have an image (.png | .jpg) containing the UML diagram and a markdown file (tentatively user's README.md file) * Create a folder in the root directory of the user's project to contain the image file. The folder name should be unique. * To show the image in README.md, append `[alt txt](relative img url)` to it.