Skip to content

Commit dbfd07f

Browse files
PaebbelsPaebbels
committed
doc: Move more sections from README.
1 parent cee4caf commit dbfd07f

10 files changed

Lines changed: 410 additions & 33 deletions

File tree

‎doc/Glossary.rst‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,41 @@ Glossary
33

44
.. glossary::
55

6+
GTKWave
7+
tbd
8+
9+
.. rubric:: Further reading
10+
11+
* GitHub: https://github.com/gtkwave/gtkwave
12+
* Website: https://gtkwave.github.io/gtkwave/ |br| https://gtkwave.sourceforge.net/
13+
614
OSVVM
15+
**O**pen-**S**ource **V**HDL **V**erification **M**ethodology
16+
17+
.. rubric:: Further reading
18+
19+
* GitHub: https://github.com/OSVVM/OsvvmLibraries
20+
* Website: https://osvvm.github.io/
21+
22+
Surfer
723
tbd
824

25+
.. rubric:: Further reading
26+
27+
* Website: https://surfer-project.org/
28+
929
Tcl
10-
Tool Command Language
30+
**T**ool **C**ommand **L**anguage
31+
32+
.. rubric:: Further reading
33+
34+
* Wikipedia: https://en.wikipedia.org/wiki/Tcl
35+
* Website: https://www.tcl-lang.org/
36+
37+
YAML
38+
**Y**AML **A**in't **M**arkup **L**anguage
1139
1240
.. rubric:: Further reading
1341

14-
* https://en.wikipedia.org/wiki/Tcl
15-
* https://www.tcl-lang.org/
42+
* Wikipedia: https://en.wikipedia.org/wiki/YAML
43+
* Website: https://yaml.org/

‎doc/Installation.rst‎

Lines changed: 86 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,96 @@
33
Installation/Updates
44
####################
55

6-
Clone OSVVM Libraries
7-
*********************
6+
.. image:: https://img.shields.io/badge/OSVVM-OsvvmLibraries-EDB74E.svg?longCache=true&logo=GitHub&labelColor=333333
7+
:alt: Sourcecode on GitHub
8+
:height: 22
9+
:target: https://github.com/OSVVM/OsvvmLibraries
10+
.. image:: https://img.shields.io/github/v/tag/OSVVM/OsvvmLibraries
11+
:target: https://github.com/OSVVM/OsvvmLibraries/releases/latest
12+
:alt: GitHub Release
13+
14+
OSVVM is hosted and developed on https://github.com/OSVVM. It's components are split into multiple Git repositories,
15+
which be used individually or as a group. The all-in-one repository is called
16+
`OsvvmLibraries <https://github.com/OSVVM/OsvvmLibraries>`__.
817

9-
Download OSVVM Libraries
10-
************************
1118

1219
OSVVM is available as either a git repository OSVVM Libraries or a zip file from osvvm.org Downloads Page.
1320

14-
On GitHub, all OSVVM libraries are a submodule of the repository OsvvmLibraries. Download all OSVVM libraries using
15-
``git clone`` with the ``–recursive`` flag:
21+
Clone OsvvmLibraries
22+
********************
23+
24+
OsvvmLibraries summarizes all OSVVM repositories into a single parent repository, which has OSVVM's components
25+
registered as Git submodules. |br|
26+
When cloning ensure to append the ``–recursive`` flag.
27+
28+
.. code-block:: bash
29+
30+
git clone --recursive https://github.com/OSVVM/OsvvmLibraries.git
31+
32+
.. seealso::
33+
34+
Git Documentation: `git clone <https://git-scm.com/docs/git-clone>`__
35+
36+
37+
Register OsvvmLibraries as Git Submodule
38+
****************************************
39+
40+
Usually, OSVVM will be part of a bigger HDL project structure also maintained in Git. Therefore, it's best to integrate
41+
OSVVM as a submodule into that project. The following commands assume, OSVVM gets added into ``./lib/OsvvmLibraries``.
1642

1743
.. code-block:: bash
1844
19-
git clone --recursive https://github.com/osvvm/OsvvmLibraries
45+
cd <project>/lib
46+
git submodule add https://github.com/OSVVM/OsvvmLibraries.git
47+
git submodule update --init --recursive
48+
49+
.. seealso::
50+
51+
Git Documentation: `git submodule add <https://git-scm.com/docs/git-submodule>`__
52+
53+
54+
Register Individual VCs as Git Submodule
55+
****************************************
56+
57+
.. todo::
58+
59+
describe individual submodule workflow
60+
61+
Updating OSVVM or OSVVM Components
62+
**********************************
63+
64+
.. todo::
65+
66+
describe update process using Git
67+
68+
69+
Download OSVVM Libraries
70+
************************
71+
72+
.. image:: https://img.shields.io/github/v/release/OSVVM/OsvvmLibraries
73+
:target: https://github.com/OSVVM/OsvvmLibraries/releases/latest
74+
:alt: GitHub Release
75+
76+
OsvvmLibraries is also offered as an archive at https://github.com/OSVVM/OsvvmLibraries/releases/latest
77+
78+
* ``https://github.com/OSVVM/OsvvmLibraries/releases/download/<version>/OsvvmLibraries-<version>.tar.gz``
79+
* ``https://github.com/OSVVM/OsvvmLibraries/releases/download/<version>/OsvvmLibraries-<version>.tar.zstd``
80+
* ``https://github.com/OSVVM/OsvvmLibraries/releases/download/<version>/OsvvmLibraries-<version>.zip``
81+
82+
.. attention::
83+
84+
Downloading the archive provided by GitHub's source code download doesn't include the submodule's code. Therefore
85+
OSVVM added a CI job for packaging all sources (incl. submodules) into a single archive.
86+
87+
88+
Business Continuity Planning
89+
****************************
90+
91+
.. todo:
92+
93+
describe fork structure
94+
95+
1. fork on GitHub
96+
2. mirror to local Git server (e.g. GitLab)
97+
3. clone to local machine
98+

‎doc/Reports.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. _RPT:
2+
3+
Reports (HTML)
4+
##############
5+
6+
Overview
7+
********
8+
9+
10+
11+
Build Index
12+
***********
13+
14+
15+
16+
Build Summary Report
17+
********************
18+
19+
20+
Testcase Summary
21+
****************
22+
23+
24+
AlertLog Report
25+
***************
26+
27+
28+
29+
Reports (XML)
30+
#############
31+
32+
JUnit Test Summary Report
33+
*************************
34+
35+
36+
Reports (YAML)
37+
##############
38+
39+
The reports in YAML format are an intermediate format used within OSVVM Script. These are the data source for generating
40+
HTML and XML reports. A detailed YAML data format description can be found in :ref:`YAML`

‎doc/Reports/index.rst‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎doc/Support.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
.. _SUPPORT:
3+
4+
Support
5+
#######
6+
7+
.. todo::
8+
9+
* Gitter
10+
* GitHub issues
11+
* osvvm blog
12+
* osvvm forum
13+
14+
15+
Reporting Bugs
16+
**************
17+
18+
Suggesting Enhancements
19+
***********************
20+

‎doc/ToolSpecific.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Quick Overview
5454

5555
.. code-block:: tcl
5656
57-
source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl
57+
source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl
5858
5959
.. tab-item:: Siemens Visualizer
6060
:sync: Visualizer
@@ -63,7 +63,7 @@ Quick Overview
6363

6464
.. code-block:: tcl
6565
66-
source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl
66+
source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl
6767
6868
.. tab-item:: Siemens EDA Questa / QuestaSim
6969
:sync: Questa
@@ -72,7 +72,7 @@ Quick Overview
7272

7373
.. code-block:: tcl
7474
75-
source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl
75+
source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl
7676
7777
.. tab-item:: Siemens EDA ModelSim
7878
:sync: ModelSim
@@ -81,7 +81,7 @@ Quick Overview
8181

8282
.. code-block:: tcl
8383
84-
source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl
84+
source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl
8585
8686
8787
.. _SIM/Aldec:
@@ -99,7 +99,7 @@ Initialize the OSVVM Script environment with the following commands:
9999
.. code-block:: tcl
100100
101101
scripterconf -tcl
102-
do -tcl <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl
102+
do -tcl <path-to-OsvvmLibraries>/Scripts/StartUp.tcl
103103
104104
Want to avoid doing this every time? For ActiveHDL, edit :file:`/script/startup.do` and add above to it. Similarly for
105105
**VSimSA**, edit :file:`/BIN/startup.do` and add the above to it.
@@ -150,9 +150,9 @@ Initialize the OSVVM Script environment within **tclsh**:
150150
.. code-block:: tcl
151151
152152
winpty tclsh
153-
source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl
153+
source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl
154154
155-
To simplify the startup process, put :file:`source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl` into
155+
To simplify the startup process, put :file:`source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl` into
156156
:file:`.tclshrc` and add a Windows short cut that calls ``C:\msys64\ucrt64.exe winpty tclsh``. This will open a UCRT64
157157
console window with a Tcl shell and pre-loaded OSVVM Script environment.
158158

@@ -177,9 +177,9 @@ Initialize the OSVVM Script environment within **tclsh**:
177177
.. code-block:: tcl
178178
179179
rlwrap tclsh
180-
source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl
180+
source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl
181181
182-
To simplify this, put :file:`source <path-to-OsvvmLibraries>/OsvvmLibraries/Scripts/StartUp.tcl` in the :file:`.tclshrc`
182+
To simplify this, put :file:`source <path-to-OsvvmLibraries>/Scripts/StartUp.tcl` in the :file:`.tclshrc`
183183
file and in Bash add ``alias gsim='rlwrap tclsh'`` to your :file:`.bashrc`.
184184

185185
.. _SIM/NVC:

0 commit comments

Comments
 (0)