HDLRuby 3.7.0 → 3.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,3 @@
1
1
  module HDLRuby
2
- VERSION = "3.7.0"
2
+ VERSION = "3.7.2"
3
3
  end
@@ -131,6 +131,12 @@ To do this, you can use the following command:</p>
131
131
  </code></pre>
132
132
  <p><strong>Note</strong>: for the command above, it is assumed that 'adder.v' contains a simulation benchmark.</p>
133
133
  <p>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.</p>
134
+ <h3>1.4. About the HDLRuby files.</h3>
135
+ <p>The HDLRuby files, that include HDLRuby description of circuits, are text files (the default encoding is UTF-8), is file name's extension is by convension <code>.rb</code>. It is possible to include other HDLRuby file within the current one using the <code>require</code> (for HDLRuby standard files) or <code>require_relative</code> (for local HDLRuby files) methods as follows:</p>
136
+ <pre><code class="language-ruby">require &quot;filename&quot;
137
+ require_relative &quot;path_to_another_filename&quot;
138
+ </code></pre>
139
+ <p>As it will be seen later, software Ruby code can also be used for generic descriptions of circuits. It is also possible to include Ruby code from different files using respectively <code>require_ruby</code> for standard libraries and gems, and <code>require_relative_ruby</code> for local files.</p>
134
140
  <h2>2. How to represent a circuit in HDLRuby</h2>
135
141
  <p>In this section we will see:</p>
136
142
  <ul>
data/tuto/tutorial_sw.md CHANGED
@@ -187,6 +187,18 @@ __Note__: for the command above, it is assumed that 'adder.v' contains a simulat
187
187
 
188
188
  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.
189
189
 
190
+ ### 1.4. About the HDLRuby files.
191
+
192
+ The HDLRuby files, that include HDLRuby description of circuits, are text files (the default encoding is UTF-8), is file name's extension is by convension `.rb`. It is possible to include other HDLRuby file within the current one using the `require` (for HDLRuby standard files) or `require_relative` (for local HDLRuby files) methods as follows:
193
+
194
+ ```ruby
195
+ require "filename"
196
+ require_relative "path_to_another_filename"
197
+ ```
198
+
199
+ As it will be seen later, software Ruby code can also be used for generic descriptions of circuits. It is also possible to include Ruby code from different files using respectively `require_ruby` for standard libraries and gems, and `require_relative_ruby` for local files.
200
+
201
+
190
202
 
191
203
  ## 2. How to represent a circuit in HDLRuby
192
204
 
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: HDLRuby
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.7.0
4
+ version: 3.7.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Lovic Gauthier
8
8
  bindir: exe
9
9
  cert_chain: []
10
- date: 2025-03-07 00:00:00.000000000 Z
10
+ date: 2025-03-24 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: bundler
@@ -491,7 +491,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
491
491
  - !ruby/object:Gem::Version
492
492
  version: '0'
493
493
  requirements: []
494
- rubygems_version: 3.6.5
494
+ rubygems_version: 3.6.6
495
495
  specification_version: 4
496
496
  summary: HDLRuby is a library for describing and simulating digital electronic systems.
497
497
  test_files: []