search

jfeliu007 / goplantuml

PlantUML Class Diagram Generator for golang projects
MIT License
1.77k stars 166 forks source link

Adding some usage example in the readme #154

Closed a-kbd closed 1 year ago

a-kbd commented 1 year ago

Perhaps there should be some usage example in the readme on how to generate the diagram pictures locally as that took a while for me to figure out, the dumels.com currently mentioned in the readme only takes in a repository URL and no way to generate diagrams using textfiles generated by goplantuml

Perhaps adding something about installing and using plantuml diagram_file_name.puml or suggesting https://www.planttext.com/ after the line where it tells you how to generate the puml file, i.e. after the line goplantuml [-recursive] path/to/gofiles path/to/gofiles2 > diagram_file_name.puml

jfeliu007 commented 1 year ago

I was trying to avoid using plant uml in the instructions because that's another tool that requires its own explanation on how to install it but I get your point. I will add a link to the plantuml online server rendering the example code. and links to the Plantuml site for further instructions.