README.md in ruby_uml_class-0.2.0 vs README.md in ruby_uml_class-0.3.0

- old
+ new

@@ -1,37 +1,45 @@ -# RubyUmlClass - -RubyUmlClass creates a Ruby class diagram. -PlantUML and rufo commands are used to create class diagrams. -The created class diagram is displayed on the browser screen. - -## Setup - for ubuntu - $ sudo apt install plantuml - -## Installation - -Install the gem and add to the application's Gemfile by executing: - - $ bundle add ruby_uml_class - -If bundler is not being used to manage dependencies, install the gem by executing: - - $ gem install ruby_uml_class - -## Usage - - $ start_ruby_uml_class.rb - -https://user-images.githubusercontent.com/88954426/211500980-3bb839a9-8cf5-44da-b8f9-733a87f22c96.mp4 - -## Development - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). - -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/kuwayama1971/RubyUmlClass. - -## License - -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +# RubyUmlClass + +RubyUmlClass creates a Ruby class diagram. +PlantUML and rufo commands are used to create class diagrams. +The created class diagram is displayed on the browser screen. + +## Setup + for ubuntu + $ sudo apt install plantuml + + for windoes + install java and PlanUML + Set java and plantuml.jar in [PlantUML Command] + PlantUML of vscode extension function is also possible + + Set [RubyUmlClass=>Setting=>PlantUML Command] as follows + "java -jar C:/Users/%USERNAME%/.vscode/extensions/jebbs.plantuml-2.17.5/plantuml.jar -svg --charset UTF-8" + +## Installation + +Install the gem and add to the application's Gemfile by executing: + + $ bundle add ruby_uml_class + +If bundler is not being used to manage dependencies, install the gem by executing: + + $ gem install ruby_uml_class + +## Usage + + $ start_ruby_uml_class.rb + +https://user-images.githubusercontent.com/88954426/211500980-3bb839a9-8cf5-44da-b8f9-733a87f22c96.mp4 + +## Development + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/kuwayama1971/RubyUmlClass. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).