rggen 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4172fd2f5f4cd0057a7fc111b09875210f0c4412010c43f9a392ca2fd397dd19
-  data.tar.gz: 1f87ff6cb6fb59f71667990046e0472babb587a302558fc3335bce9978b6a7ce
+  metadata.gz: dd38a06acb7dd567dd0620cdf0cac277f5be85cf3eda2976bd94f40b09d2f1bc
+  data.tar.gz: e557922b390055ea15eaaabcf10f27b91c63ab734b8d8fbc294b34edf395e277
 SHA512:
-  metadata.gz: 0ca86e4abdce41d600fc85c33ea3b9443427ac7008536b1251555cfd11fc49524d486cd8b2f34026488bce55ceacfb68d219df5a07d43f66fec6f6ff042153d2
-  data.tar.gz: 0f07ca3274875a19a68febed52dabc220284328a8173a084dcfe260a0a516521afa557dd3cd94e3771e03007ff3a2fa3556170bd39265aec8ef26c58c9ba5a74
+  metadata.gz: 1c825e164ce8336075ed7c820fb9ab2c194993dab51402a6458c1cf8906fb690f6ae13daf71b73298685145adc8b59f39566ff68f035907e971d8bb3cedf96ad
+  data.tar.gz: 06fffe85f27326411b39d201f852c4fc7e072d80c833f8da1f2b4d8c54ec6962cc7e4fa3554ce39e71dccf78f382f3eb61b610fe3ce019a027050935e414e9bb

data/README.md

@@ -7,7 +7,7 @@
 
 # RgGen
 
-RgGen is a code generation tool for ASIC/IP/FPGA/RTL engineers. It will automatically generate soruce code related to control/status registers (CSR), e.g. SytemVerilog RTL, UVM RAL model, Wiki documents, from human readable register map specifications.
+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 RAL model, Wiki documents, from human readable register map specifications.
 
 RgGen has following features:
 
@@ -68,6 +68,39 @@ To resolve the above error, there are three solutions. See [this page](https://g
 
 See [Wiki documents](https://github.com/rggen/rggen/wiki).
 
+## Example
+
+You can get example configuration file and register map specification listed below:
+
+* Configuration file
+    * https://github.com/rggen/rggen-sample/blob/master/config.yml
+* Register map specifications
+    * https://github.com/rggen/rggen-sample/blob/master/block_0.yml
+    * https://github.com/rggen/rggen-sample/blob/master/block_1.yml
+
+By using these example files, you can try to use RgGen. Hit command below:
+
+```
+$ rggen -c config.yml -o out block_0.yml block_1.yml
+```
+
+* `-c`
+    * Specify path to your configuration file
+* `-o`
+    * Specify path to the directory where generated files will be written to
+
+Then, generated files listed below will be written to `out` directory.
+
+* SystemVerilog RTL
+    * https://github.com/rggen/rggen-sample/blob/master/block_0.sv
+    * https://github.com/rggen/rggen-sample/blob/master/block_1.sv
+* UVM RAL model
+    * https://github.com/rggen/rggen-sample/blob/master/block_0_ral_pkg.sv
+    * https://github.com/rggen/rggen-sample/blob/master/block_1_ral_pkg.sv
+* Markdown document
+    * https://github.com/rggen/rggen-sample/blob/master/block_0.md
+    * https://github.com/rggen/rggen-sample/blob/master/block_1.md
+
 ## Contact
 
 Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
@@ -88,7 +121,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 ## Copyright & License
 
-Copyright © 2019 Taichi Ishitani. RgGen is licensed unther the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
+Copyright © 2019 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.16.0'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rggen-core
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: rggen-default-register-map
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: rggen-markdown
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement