Skip to content

Commit

Permalink
Updated developer doc and mistake in rtl-code doc
Browse files Browse the repository at this point in the history
  • Loading branch information
abnashkb committed Oct 13, 2024
1 parent 068b4e3 commit 2afa782
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions docs/rad-sim-developer.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
RAD-Sim Developers
===================

WARNING/TODO: this guide has not been updated or tested with multi-RAD RADSim. This is functional for single-RAD RADSim.

RAD-Sim Testing Infrastructure
-------------------------------

Python Scripts Tests
^^^^^^^^^^^^^^^^^^^^^
.. note::
This script does not currently work in multi-RAD RAD-Sim.

To run python tests, ensure the current working directory is in the ``rad-sim`` folder and run the following steps:

#. ``python -m unittest discover .``
Expand Down
2 changes: 1 addition & 1 deletion docs/rad-sim-rtl-code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ An example design that utilizes RTL modules can be found in the ``rad-sim/exampl

.. note::
RAD-Sim adds a portal module for designs containing multiple RADs. The NoC, clock, and general configuration files
should be modified according to the developer guide.
should be modified according to the code structure guide.

RTL CMakeLists
---------------
Expand Down

0 comments on commit 2afa782

Please sign in to comment.