v0.2.0

# New Features

* Added *main goals*, *features* and *example* code to README.
* Added a basic documentation website.
  * Navigation bar
  * Landing page
  * Installation instructions
  * Dependencies
  * Licenses

# Changes

* Renamed from `pyEDAA.Configure` to `pyEDAA.ToolSetup`.
* Changes due to an updated version of pyTooling/Actions.
  * Added more artifact names to the cleanup rule.
  
# Bug Fixes

* Add missing `doc/prolog.inc`.

---

**Related PR:**

* #4

Author: umarcor

.github/workflows/Pipeline.yml

@@ -11,7 +11,8 @@ jobs:
   Params:
     uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
     with:
-      name: pyEDAA.Configure
+      name: pyEDAA.ToolSetup
+      system_list: 'ubuntu windows macos'
 
   UnitTesting:
     uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r0
@@ -40,7 +41,7 @@ jobs:
       requirements: '-r tests/requirements.txt'
       commands: |
         cd pyEDAA
-        mypy --html-report ../htmlmypy -p Configure
+        mypy --html-report ../htmlmypy -p ToolSetup
       report: 'htmlmypy'
       artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
 
@@ -121,11 +122,19 @@ jobs:
     with:
       package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
       remaining: |
-        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.6
-        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.7
-        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.8
-        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.9
-        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-3.10
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.7
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.8
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.9
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.10
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-windows-3.7
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-windows-3.8
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-windows-3.9
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-windows-3.10
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-msys2-3.9
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-macos-3.7
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-macos-3.8
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-macos-3.9
+        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-macos-3.10
         ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
         ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
         ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}

.gitignore

@@ -17,8 +17,8 @@ coverage.xml
 
 # Sphinx
 doc/_build/
-doc/pyEDAA.Configure/**/*.*
-!doc/pyEDAA.Configure/index.rst
+doc/pyEDAA.ToolSetup/**/*.*
+!doc/pyEDAA.ToolSetup/index.rst
 
 # BuildTheDocs
 doc/_theme/**/*.*

.idea/pyEDAA.Configure.iml .idea/pyEDAA.ToolSetup.iml.idea/pyEDAA.Configure.iml renamed to .idea/pyEDAA.ToolSetup.iml

@@ -1,51 +1,105 @@
 <p align="center">
-  <a title="edaa-org.github.io/pyEDAA.Configuration" href="https://edaa-org.github.io/pyEDAA.Configuration"><img height="80px" src="doc/_static/logo.svg"/></a>
+  <a title="edaa-org.github.io/pyEDAA.ToolSetup" href="https://edaa-org.github.io/pyEDAA.ToolSetup"><img height="80px" src="doc/_static/logo.svg"/></a>
 </p>
 
-[![Sourcecode on GitHub](https://img.shields.io/badge/pyEDAA-Configuration-ffca28.svg?longCache=true&style=flat-square&logo=GitHub&labelColor=ff8f00)](https://GitHub.com/edaa-org/pyEDAA.Configuration)
-[![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=edaa-org.github.io%2FpyEDAA.Configuration&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2Fedaa-org.github.io%2FpyEDAA.Configuration%2Findex.html)](https://edaa-org.github.io/pyEDAA.Configuration/)
+[![Sourcecode on GitHub](https://img.shields.io/badge/pyEDAA-ToolSetup-ffca28.svg?longCache=true&style=flat-square&logo=github&longCache=true&logo=GitHub&labelColor=ff8f00)](https://GitHub.com/edaa-org/pyEDAA.ToolSetup)
+[![Sourcecode License](https://img.shields.io/pypi/l/pyEDAA.ToolSetup?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
+[![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=edaa-org.github.io%2FpyEDAA.ToolSetup&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2Fedaa-org.github.io%2FpyEDAA.ToolSetup%2Findex.html)](https://edaa-org.github.io/pyEDAA.ToolSetup/)
+[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](LICENSE.md)
 [![Gitter](https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef)](https://gitter.im/hdl/community)  
-[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/edaa-org/pyEDAA.Configuration/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://GitHub.com/edaa-org/pyEDAA.Configuration/actions/workflows/Pipeline.yml)
+[![PyPI](https://img.shields.io/pypi/v/pyEDAA.ToolSetup?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/pyEDAA.ToolSetup/)
+![PyPI - Status](https://img.shields.io/pypi/status/pyEDAA.ToolSetup?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyEDAA.ToolSetup?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)  
+[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/edaa-org/pyEDAA.ToolSetup/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://GitHub.com/edaa-org/pyEDAA.ToolSetup/actions/workflows/Pipeline.yml)
+[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyEDAA.ToolSetup?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/edaa-org/pyEDAA.ToolSetup)
+[![Codacy - Quality](https://img.shields.io/codacy/grade/2245747238a94667b25f75970b86a333?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/gh/edaa-org/pyEDAA.ToolSetup)
+[![Codacy - Coverage](https://img.shields.io/codacy/coverage/2245747238a94667b25f75970b86a333?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/gh/edaa-org/pyEDAA.ToolSetup)
+[![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/edaa-org/pyEDAA.ToolSetup?longCache=true&style=flat-square&logo=Codecov)](https://codecov.io/gh/edaa-org/pyEDAA.ToolSetup)
 
 <!--
-[![Sourcecode License](https://img.shields.io/pypi/l/pyEDAA.Configuration?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
-[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](LICENSE.md)
-
-[![PyPI](https://img.shields.io/pypi/v/pyEDAA.Configuration?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/pyEDAA.Configuration/)
-![PyPI - Status](https://img.shields.io/pypi/status/pyEDAA.Configuration?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyEDAA.Configuration?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
-
-[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyEDAA.Configuration?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/edaa-org/pyEDAA.Configuration)
-[![Codacy - Quality](https://img.shields.io/codacy/grade/39d312bf98244961975559f141c3e000?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.Configuration)
-[![Codacy - Coverage](https://img.shields.io/codacy/coverage/39d312bf98244961975559f141c3e000?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.Configuration)
-[![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/edaa-org/pyEDAA.Configuration?longCache=true&style=flat-square&logo=Codecov)](https://codecov.io/gh/edaa-org/pyEDAA.Configuration)
-
-[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyEDAA.Configuration?longCache=true&style=flat-square&logo=GitHub)](https://GitHub.com/edaa-org/pyEDAA.Configuration/network/dependents)
-[![Requires.io](https://img.shields.io/requires/github/edaa-org/pyEDAA.Configuration?longCache=true&style=flat-square)](https://requires.io/github/EDAA-ORG/pyEDAA.Configuration/requirements/?branch=main)
-[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyEDAA.Configuration?longCache=true&style=flat-square)](https://libraries.io/github/edaa-org/pyEDAA.Configuration/sourcerank)
+[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyEDAA.ToolSetup?longCache=true&style=flat-square&logo=GitHub)](https://github.com/edaa-org/pyEDAA.ToolSetup/network/dependents)
+[![Requires.io](https://img.shields.io/requires/github/edaa-org/pyEDAA.ToolSetup?longCache=true&style=flat-square)](https://requires.io/github/edaa-org/pyEDAA.ToolSetup/requirements/?branch=main)
+[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyEDAA.ToolSetup)](https://libraries.io/github/edaa-org/pyEDAA.ToolSetup/sourcerank)  
 -->
 
+
 <p align="center">
-  <a title="edaa-org.github.io/pyEDAA.Configuration" href="https://edaa-org.github.io/pyEDAA.Configuration"><img height="275px" src="doc/_static/work-in-progress.png"/></a>
+  <a title="edaa-org.github.io/pyEDAA.ToolSetup" href="https://edaa-org.github.io/pyEDAA.ToolSetup"><img height="275px" src="doc/_static/work-in-progress.png"/></a>
 </p>
 
 
 # Main Goals
 
-* *tbd*
+* Provide abstract information of where a tool is installed and configured on the local machine.
+* Find local EDA tool installations and gather all necessary information in a configuration file.
+* Support multiple versions and variants of the same tool.
+* In case of multiple tool versions/variants select one default installation.
+* Allow switching the default version/variant.
+* Allow reading and writing such a configuration file via API.
+* Allow reading and writing such a configuration file via CLI.
 
 
-# Use Cases
+# Features
+
+* Find tool installations:
+  * at default installation locations (based on operating system).
+  * in `PATH`.
+  * via environment variables.
+* Support multiple versions of the same tool.  
+  E.g. Vivado 2018.3, 2021.2
+* Support multiple variants of the same tool.  
+  E.g. ModelSim Altera Edition vs. ModelSim SE vs. QuestaSim
+* Configuring a default version/variant per tool.
+
+
+# Condensed View on `ToolInformation` Class
+
+```python
+from pathlib import Path
+from pyTooling.Decorators import export
 
-* *tbd*
+@export
+class ToolInformation:
+  def __init__(self, installationDirectory: Path, binaryDirectory: Path, version: str = None, edition: str = None): ...
+
+  @property
+  def InstallationDirectory(self) -> Path:
+    return self._installationDirectory
+
+  @property
+  def BinaryDirectory(self) -> Path:
+    return self._binaryDirectory
+
+  @property
+  def Version(self) -> str:
+    return self._version
+
+  @property
+  def Edition(self) -> str:
+    return self._edition
+```
 
 
 # Examples
 
 ```python
-print(some.python.code.here())
+from pathlib import Path
+from pyEDAA.ToolSetup import Installations
+
+yamlFile = Path("configuration.yml")
+
+installation = Installations(yamlFile)
+activeHDL = installation.Aldec.ActiveHDL
+activeHDLVersion = activeHDL["10.3"]
+print(activeHDLVersion.BinaryDirectory)
 ```
 
+# Consumers
+
+This layer is used by:
+
+* 🚧 pyEDAA.Workflow
+
 
 # References
 
@@ -56,7 +110,7 @@ print(some.python.code.here())
 * [Patrick Lehmann](https://github.com/Paebbels) (Maintainer)
 * [Martin Zabel](https://github.com/mzabeltud)
 * [Unai Martinez-Corral](https://github.com/umarcor)
-* [and more...](https://github.com/edaa-org/pyEDAA.Configuration/graphs/contributors)
+* [and more...](https://github.com/edaa-org/pyEDAA.ToolSetup/graphs/contributors)
 
 
 # License

README.md

@@ -0,0 +1,13 @@
+Data Model
+##########
+
+Abstract and Basic Information Classes
+**************************************
+
+*TBD*
+
+
+Abstract Data Model Classes
+***************************
+
+*TBD*