HDLRuby 3.4.0 → 3.5.0

data/tuto/tutorial_sw.md

@@ -48,7 +48,7 @@ To use HDLRuby the following software is required:
 
 The following software is also recommended:
 
- * A wave viewer supporting *vcd* files (e.g., [GTKWave](https://gtkwave.sourceforge.net/).)
+ * A wave viewer supporting *vcd* files (e.g., [GTKWave](https://gtkwave.sourceforge.net/), or, [HTMLWave](https://civol.github.io/htmlwave/htmlwave.html))
 
 ## 1. What is HDLRuby and how to use its framework
 
@@ -131,10 +131,10 @@ Up to now, we said that HDLRuby is a language, it is in truth a complete framewo
 Basically, `hdrcc` is used as follows:
 
 ```bash
-hdrcc <options> <input file> <output directory>
+hdrcc <options> <input file> <output/working directory>
 ```
 
-Where `options` specifies the action to be performed, `input file` specifies the input HDLRuby file, and `output directory` specifies the directory where the command results will be saved. As a general rule, when an input file is specified, an output directory must also be specified.
+Where `options` specifies the action to be performed, `input file` specifies the input HDLRuby file, and `output/working directory` specifies the directory where the command results will be saved. As a general rule, when an input file is specified, an output directory must also be specified.
 
 Several actions are possible using `hdrcc`, the main ones being the following:
 
@@ -144,6 +144,11 @@ Several actions are possible using `hdrcc`, the main ones being the following:
  hdrcc --sim <input file> <output directory>
  ```
 
+ * Generate a graphical representation of the RTL code in SVG format:
+
+ ```bash
+ hdrcc --svg <input file> <output directory>
+
  * Generate the equivalent Verilog HDL code:  
 
  ```bash
@@ -171,6 +176,14 @@ For example, assuming that you have a Verilog ddHDL named 'adder.v' describing a
 v2hdr adder.v adder.rb
 ```
 
+It is also possible to directly use a Verilog file as input to 'hdrcc', but its top module must be specified. For example, to directly simulate the previous 'adder.v', and assuming its top module is 'adder' you can do as follows:
+
+```bash
+hdrcc --sim -t adder adder.v adder
+```
+
+__Note__: for the command above, it is assumed that 'adder.v' contains a simulation benchmark.
+
 
 And that's it! For details about all the actions that can be performed, how to write an input file, and what kind of output can be produced, let us see the remaining of the tutorial.
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: HDLRuby
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Lovic Gauthier
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-21 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +130,7 @@ files:
 - lib/HDLRuby/hdr_samples/dff_properties.rb
 - lib/HDLRuby/hdr_samples/dff_unit.rb
 - lib/HDLRuby/hdr_samples/enum_as_param.rb
+- lib/HDLRuby/hdr_samples/hard_to_route.rb
 - lib/HDLRuby/hdr_samples/huge_rom.rb
 - lib/HDLRuby/hdr_samples/if_bench.rb
 - lib/HDLRuby/hdr_samples/include.rb
@@ -210,6 +210,7 @@ files:
 - lib/HDLRuby/hdr_samples/with_fixpoint_adv.rb
 - lib/HDLRuby/hdr_samples/with_fsm.rb
 - lib/HDLRuby/hdr_samples/with_function_generator.rb
+- lib/HDLRuby/hdr_samples/with_generic_in_generic.rb
 - lib/HDLRuby/hdr_samples/with_handshake.rb
 - lib/HDLRuby/hdr_samples/with_init.rb
 - lib/HDLRuby/hdr_samples/with_instance.rb
@@ -231,6 +232,9 @@ files:
 - lib/HDLRuby/hdr_samples/with_reduce.rb
 - lib/HDLRuby/hdr_samples/with_ref_array.rb
 - lib/HDLRuby/hdr_samples/with_ref_expr.rb
+- lib/HDLRuby/hdr_samples/with_seq_case.rb
+- lib/HDLRuby/hdr_samples/with_seq_if.rb
+- lib/HDLRuby/hdr_samples/with_seq_if_succ.rb
 - lib/HDLRuby/hdr_samples/with_sequencer.rb
 - lib/HDLRuby/hdr_samples/with_sequencer_channel.rb
 - lib/HDLRuby/hdr_samples/with_sequencer_deep.rb
@@ -348,6 +352,7 @@ files:
 - lib/HDLRuby/hruby_values.rb
 - lib/HDLRuby/hruby_verilog.rb
 - lib/HDLRuby/hruby_verilog_name.rb
+- lib/HDLRuby/hruby_viz.rb
 - lib/HDLRuby/low_samples/adder.yaml
 - lib/HDLRuby/low_samples/after.yaml
 - lib/HDLRuby/low_samples/before.yaml
@@ -468,7 +473,6 @@ homepage: https://github.com/civol/HDLRuby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -484,8 +488,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.0
 specification_version: 4
 summary: HDLRuby is a library for describing and simulating digital electronic systems.
 test_files: []