rggen 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 147c36b9a7ceb0524adf5645ea90506daaf41b8255f4b4f49edfa5f9153033ca
-  data.tar.gz: c58afb983c9b6e8524ef68c391eb06038bdc37c9f8838e38e4a101ee1275008b
+  metadata.gz: 445b048134a674c3394d95f1dfb7bdf730538b5c67e726c6dbe88542d8d1f01d
+  data.tar.gz: eaad9788b4ab55e791bdd1a4190f4d34e5686d1c783f0cae4091dd8c42717fe2
 SHA512:
-  metadata.gz: 14a7ecbac475586af147de21e07cc5decbf1518e2f153e6d7e0718a15b1ecf4a108eba9fcd21b6fcdedc528b361d8f3e02d12a1fb8b4a45de3e1e3f3678b8210
-  data.tar.gz: 23ceba9ff7a579e5ef7d06acf89b3f00d38af3f6a59c32ef535a9a797f608ce9bbfb62b3843112e2b919a3a6d21f670a214fdebf718ade6a2f27215461f89cef
+  metadata.gz: 0b1f1049ed0781844dbc10ea1ea571257e06840296e84b394bc321f41e016346e774c1182397f8e0966397a5fb7c7c2dd2bb381806bd2dc30ffa20c5d87aeb07
+  data.tar.gz: dd5cc1c591e6d02e8442ae20db00454736159f1940db3abe8f8e3d73184cb85e416b753d27393ccf0ebd181b0284723702c38f71c88caac2a899abaecf7dc706

data/CONTRIBUTING.md

@@ -49,12 +49,12 @@ to fix the bug which you found or implement enhancements which you want.
 
 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
+3. Clone following 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 .`
+        * `./rggen-devtools/bin/checkout.rb --list ./rggen-checkout/all.yml --dir .`
 
 ```
 $ mkdir work

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2021 Taichi Ishitani
+Copyright (c) 2019-2022 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)
@@ -17,6 +19,8 @@ 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
@@ -27,14 +31,14 @@ RgGen has following features:
     * Spreadsheet (XLSX, XLS, OSD, CSV)
     * [SiFive DUH](https://github.com/sifive/duh)
         * Need [rggen-duh](https://github.com/rggen/rggen-duh) plugin
-* Costomize RgGen for you environment
+* Customize RgGen for you environment
     * E.g. add special bit field types
 
 ## Installation
 
 ### Ruby
 
-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/).
+RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.6 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
 
@@ -68,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.
@@ -86,10 +96,14 @@ Following EDA tools can accept the generated source files.
         * Not sure if UVM register models are accepted
     * Verilator
         * Need `-Wno-fatal` switch
+    * Icarus Verilog
+        * Verilog RTL only
 * Synthesis tools
     * Synopsys Design Compiler
     * Intel Quartus
     * Xilinx Vivado
+    * [Yosys](http://www.clifford.at/yosys/)
+        * Verilog RTL
 
 ## Example
 
@@ -145,10 +159,11 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 * 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-2021 Taichi Ishitani. RgGen is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
+Copyright © 2019-2022 Taichi Ishitani. RgGen is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
 
 ## Code of Conduct
 

data/lib/rggen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2022-03-25 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.25.0
+        version: 0.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.26.0
 - !ruby/object:Gem::Dependency
   name: rggen-default-register-map
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.25.1
+        version: 0.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.25.1
+        version: 0.26.0
 - !ruby/object:Gem::Dependency
   name: rggen-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: rggen-spreadsheet-loader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: rggen-systemverilog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.26.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,12 +111,14 @@ files:
 - lib/rggen.rb
 - lib/rggen/setup.rb
 - lib/rggen/version.rb
+- logo/rggen.png
 homepage: https://github.com/rggen/rggen
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rggen/rggen/issues
   mailing_list_uri: https://groups.google.com/d/forum/rggen
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/rggen/rggen
   wiki_uri: https://github.com/rggen/rggen/wiki
 post_install_message: 
@@ -127,14 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Code generation tool for configuration and status registers