rggen 0.23.2 → 0.25.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 745797ed1307b9c671368a1b52d283525145324c9f2bedf81f536ac02da1ca78
-  data.tar.gz: 112f1b770914e61068a08bc7dbb6dd3920bfcc41f028a24e61b00974364b6818
+  metadata.gz: a58ffca0ade8a0b097e5865b4810956d7600a90ab663d0390317a4a392149968
+  data.tar.gz: 9a9a42415f3a62dfc35cbadde99aef0345dff9a2501b7bc243609c0c06c235fd
 SHA512:
-  metadata.gz: 66120e4621041673ee2aacc7f4dd44b00377734afee4d5b93e615982b9bb6dad71f31ae2d07d57896395acb5af2aa4fad3ffa51ec7367ea6ce32952d0045f723
-  data.tar.gz: e45ce9c05b487e57ce3e81871b1933d68d89a96a359fd912ef4ad7e8fd5360e1a449b4f943982e3efcb98156d6ed6a565d2ebf82163ab75a448f005db99eaaa1
+  metadata.gz: 383473e4efc879995db77783937f7698cec0c0db8ea71054a896904cb71ad3fe2868caa30fdaa9f87937dd8d153bb033e665171f641253eeb3485fa0832af535
+  data.tar.gz: 229f6410fa3826752248eae7815a694607937784b925d67d7713ae137d2bec1245ff2f8a636cb19976f1ae762159e11be1ef117857031bbf22b3750653a0712c

data/CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing
+
+Your contributions are welcome!
+
+## Bug Report
+
+You can submit bug reports on [GitHub Issue Tracker](https://github.com/rggen/rggen/issues).
+Please include information below in your report:
+
+* How to reproduce the bug which you found
+    * test code
+    * command
+* Information about your environment
+    * Ruby/RgGen version
+    * OS
+    * etc.
+* Expected result
+
+## Question
+
+Questions are accepted on following channels:
+
+* [GitHub Discussions](https://github.com/rggen/rggen/discussions)
+* [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
+* [Gitter Chat Room](https://gitter.im/rggen/rggen)
+
+## Enhancement Request
+
+You can submit your enhancement request on [GitHub Issue Tracker](https://github.com/rggen/rggen/issues).
+
+## Pull Request
+
+You can also submit pull requests on [GitHub Issue Tracker](https://github.com/rggen/rggen/pulls)
+to fix the bug which you found or implement enhancements which you want.
+
+1. Fork the repositories which you will change
+2. Setup your working environment
+    * See the next section
+3. Add your change to the repositories
+    * You need to add RSpec exmaples if you add new features
+    * You need to make sure all existing RSpec examples pass
+        * Invoke `rake spec` on the repositry root
+4. Make sure all existing RSpec exmaples for other  repositories pass
+    * Invoke command below on the working directory
+        * `./rggen-devtools/bin/run_all_spec.rb`
+5. Commit your changes and submit a pull request
+
+### Setup Working Environment
+
+1. Create a working directory
+2. Clone your forked version of the repositories to the working directory
+3. Clone folloiwng repositories for development tools to the working directory
+    * https://github.com/rggen/rggen-devtools
+    * https://github.com/rggen/rggen-checkout
+4. Clone other RgGen's repositories
+    * Invoke commnad below on to the working directory
+        * `./rggen-devtools/bin/checkout --list ./rggen-checkout/all.yml --dir .`
+
+```
+$ mkdir work
+$ cd work
+$ git clone git@github.com:yourname/your_repository.git
+$ git clone git@github.com:rggen/rggen-devtools.git
+$ git clone git@github.com:rggen/rggen-checkout.git
+$ ./rggen-devtools/bin/checkout.rb --list ./rggen-checkout/all.yml --dir .
+```

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2020 Taichi Ishitani
+Copyright (c) 2019-2021 Taichi Ishitani
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,3 +1,5 @@
+![RgGen](logo/rggen.png)
+
 [![Gem Version](https://badge.fury.io/rb/rggen.svg)](https://badge.fury.io/rb/rggen)
 [![CI](https://github.com/rggen/rggen/workflows/CI/badge.svg)](https://github.com/rggen/rggen/actions?query=workflow%3ACI)
 [![Maintainability](https://api.codeclimate.com/v1/badges/5ee2248300ec0517e597/maintainability)](https://codeclimate.com/github/rggen/rggen/maintainability)
@@ -5,6 +7,8 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen)
 [![Gitter](https://badges.gitter.im/rggen/rggen.svg)](https://gitter.im/rggen/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
+[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A231E3I)
+
 # RgGen
 
 RgGen is a code generation tool for ASIC/IP/FPGA/RTL engineers. It will automatically generate soruce code related to configuration and status registers (CSR), e.g. SytemVerilog RTL, UVM register model (UVM RAL), Wiki documents, from human readable register map specifications.
@@ -15,12 +19,15 @@ RgGen has following features:
     * SystemVerilog RTL
     * Verilog RTL
         * Need [rggen-verilog](https://github.com/rggen/rggen-verilog) plugin
+    * VHDL RTL
+        * Need [rggen-vhdl](https://github.com/rggen/rggen-vhdl) plugin
     * UVM register model (UVM RAL)
     * Register map documents written in Markdown
 * Register map specifications can be written in human readable format
     * Ruby with APIs to describe register map information
     * YAML
     * JSON
+    * TOML
     * Spreadsheet (XLSX, XLS, OSD, CSV)
     * [SiFive DUH](https://github.com/sifive/duh)
         * Need [rggen-duh](https://github.com/rggen/rggen-duh) plugin
@@ -31,7 +38,7 @@ RgGen has following features:
 
 ### Ruby
 
-RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.4 or later. You need to install  any of these versions of Ruby before installing RgGen tool. To install Ruby, see [this page](https://www.ruby-lang.org/en/downloads/).
+RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.5 or later. You need to install  any of these versions of Ruby before installing RgGen tool. To install Ruby, see [this page](https://www.ruby-lang.org/en/downloads/).
 
 ### Installatin Command
 
@@ -65,12 +72,18 @@ ERROR:  Error installing rggen:
         "rggen" from rggen-core conflicts with installed executable from rggen
 ```
 
-To resolve the above error, there are three solutions. See [this page](https://github.com/rggen/rggen/wiki/Resolve-Confliction-of-Installed-Executable)
+To resolve the above error, there are three solutions.
+See [this page](https://github.com/rggen/rggen/wiki/Resolve-Confliction-of-Installed-Executable)
 
 ## Usage
 
 See [Wiki documents](https://github.com/rggen/rggen/wiki).
 
+## Plugin
+
+RgGen has `plugin` feature to allow your cusomization.
+See [this Wiki document](https://github.com/rggen/rggen/wiki/Create-Your-Own-Plugin) for futher detals.
+
 ## Supported Tools
 
 Following EDA tools can accept the generated source files.
@@ -119,11 +132,16 @@ Then, generated files listed below will be written to `out` directory.
     * https://github.com/rggen/rggen-sample/blob/master/block_0.md
     * https://github.com/rggen/rggen-sample/blob/master/block_1.md
 
+## Contributing
+
+See [Contributing Guide](CONTRIBUTING.md).
+
 ## Contact
 
 Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
 
 * [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
+* [GitHub Discussions](https://github.com/rggen/rggen/discussions)
 * [Chat Room](https://gitter.im/rggen/rggen)
 * [Mailing List](https://groups.google.com/d/forum/rggen)
 * [Mail](mailto:rggen@googlegroups.com)
@@ -136,11 +154,13 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 * https://github.com/rggen/rggen-markdown
 * https://github.com/rggen/rggen-spreadsheet-loader
 * https://github.com/rggen/rggen-duh
+* https://github.com/rggen/rggen-verilog
+* https://github.com/rggen/rggen-vhdl
 
 ## Copyright & License
 
-Copyright © 2019-2020 Taichi Ishitani. RgGen is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
+Copyright © 2019-2021 Taichi Ishitani. RgGen is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
 
 ## Code of Conduct
 
-Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rggen/rggen/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/lib/rggen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RgGen
-  VERSION = '0.23.2'
+  VERSION = '0.25.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen
 version: !ruby/object:Gem::Version
-  version: 0.23.2
+  version: 0.25.3
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-31 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rggen-core
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.25.1
 - !ruby/object:Gem::Dependency
   name: rggen-default-register-map
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.25.1
 - !ruby/object:Gem::Dependency
   name: rggen-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: rggen-spreadsheet-loader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: rggen-systemverilog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.25.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,11 +105,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - lib/rggen.rb
 - lib/rggen/setup.rb
 - lib/rggen/version.rb
+- logo/rggen.png
 homepage: https://github.com/rggen/rggen
 licenses:
 - MIT
@@ -126,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Code generation tool for configuration and status registers