Skip to content

Commit 2f85ec0

Browse files
committed
doc: Moved more sections from README into new locations.
1 parent 8ae4512 commit 2f85ec0

29 files changed

+644
-63
lines changed

doc/Installation.rst

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

6-
.. image:: https://img.shields.io/badge/OSVVM-OsvvmLibraries-EDB74E.svg?longCache=true&logo=GitHub&labelColor=333333
6+
.. image:: https://img.shields.io/badge/OSVVM-OSVVM--Scripts-EDB74E.svg?longCache=true&logo=GitHub&labelColor=333333
77
:alt: Sourcecode on GitHub
88
:height: 22
9-
:target: https://github.com/OSVVM/OsvvmLibraries
9+
:target: https://github.com/OSVVM/OSVVM-Scripts
1010
.. image:: https://img.shields.io/github/v/tag/OSVVM/OsvvmLibraries
1111
:target: https://github.com/OSVVM/OsvvmLibraries/releases/latest
1212
:alt: GitHub Release
1313

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
14+
OSVVM is hosted and developed at https://github.com/OSVVM. It's components are split into multiple Git repositories,
15+
which can be used individually or as a group. The all-in-one repository is called
1616
`OsvvmLibraries <https://github.com/OSVVM/OsvvmLibraries>`__.
1717

18+
See :ref:`INSTALL/Download` for downloadable archives.
1819

19-
OSVVM is available as either a git repository OSVVM Libraries or a zip file from osvvm.org Downloads Page.
20+
21+
.. _INSTALL/Clone:
2022

2123
Clone OsvvmLibraries
2224
********************
2325

24-
OsvvmLibraries summarizes all OSVVM repositories into a single parent repository, which has OSVVM's components
26+
OsvvmLibraries aggregates all OSVVM repositories into a single parent repository, which has OSVVM's components
2527
registered as Git submodules. |br|
2628
When cloning ensure to append the ``–recursive`` flag.
2729

@@ -34,6 +36,8 @@ When cloning ensure to append the ``–recursive`` flag.
3436
Git Documentation: `git clone <https://git-scm.com/docs/git-clone>`__
3537

3638

39+
.. _INSTALL/Submodule:
40+
3741
Register OsvvmLibraries as Git Submodule
3842
****************************************
3943

@@ -51,13 +55,18 @@ OSVVM as a submodule into that project. The following commands assume, OSVVM get
5155
Git Documentation: `git submodule add <https://git-scm.com/docs/git-submodule>`__
5256

5357

58+
.. _INSTALL/IndividualSubmodules:
59+
5460
Register Individual VCs as Git Submodule
5561
****************************************
5662

5763
.. todo::
5864

5965
describe individual submodule workflow
6066

67+
68+
.. _INSTALL/Updating:
69+
6170
Updating OSVVM or OSVVM Components
6271
**********************************
6372

@@ -66,6 +75,8 @@ Updating OSVVM or OSVVM Components
6675
describe update process using Git
6776

6877

78+
.. _INSTALL/Download:
79+
6980
Download OSVVM Libraries
7081
************************
7182

@@ -85,6 +96,14 @@ OsvvmLibraries is also offered as an archive at https://github.com/OSVVM/OsvvmLi
8596
OSVVM added a CI job for packaging all sources (incl. submodules) into a single archive.
8697

8798

99+
.. todo::
100+
101+
OSVVM is available as either a git repository OSVVM Libraries or a zip file from osvvm.org Downloads Page.
102+
103+
`Downlaods from osvvm.org <https://osvvm.org/downloads>`__
104+
105+
.. _INSTALL/BusinessContinuity:
106+
88107
Business Continuity Planning
89108
****************************
90109

@@ -95,4 +114,3 @@ Business Continuity Planning
95114
1. fork on GitHub
96115
2. mirror to local Git server (e.g. GitLab)
97116
3. clone to local machine
98-

doc/QuickStartGuide.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Quick Start Guide
44
#################
55

6+
.. important::
7+
8+
If you haven't installed OsvvmLibraries yet, please get OSVVM using one of the described methods in :ref:`INSTALL`
9+
610
Create a Simulation directory
711
*****************************
812

@@ -15,6 +19,13 @@ The following assumes you have created a directory named :file:`sim` in the :fil
1519
Alternately, you can run simulations out of the Scripts, but cleanup is a mess as a simulator tends to create numerous
1620
temporaries.
1721

22+
.. todo::
23+
24+
Is :file:`sim_vendor-name` still valid?
25+
26+
What about :file:`temp`?
27+
28+
1829
Start the Script environment in the Simulator
1930
*********************************************
2031

@@ -132,3 +143,13 @@ API. The script API is created using Tcl procedures.
132143

133144
If you were to open :file:`testbench_MultipleMemory.pro`, you would find that ``RunTest`` is used instead as it is
134145
an abbreviation for the ``analyze``, ``TestName`` and ``simulate`` when the names are the same.
146+
147+
148+
Regression.tcl
149+
**************
150+
151+
.. todo::
152+
153+
Show how a regression.tcl could look like assuming OSVVM is a git submodule.
154+
155+

doc/Reports.rst

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

0 commit comments

Comments
 (0)