README.adoc

Общая информация

Данный репозиторий содержит Python-исходники, используемые при сборке HDL-проектов или верификационных окружений. Репозиторий представляет собой Python-паккейдж.

Структура репозитория

• setup.py — установочный скрипт репозитория

• <паккейдж_1> — директория 1-го паккейджа репозитория

  • <название_паккейджа_1>.py — Python-исходник паккейджа

  • test — директория с тестами паккейджа и примерами его использования

• …​

• <паккейдж_N> — директория N-го паккейджа репозитория

Рекомендации к модифифцированию репозитория

• соблюдение структуры репозитория

• создание документации на Python-исходники встроенными средствами Python

Использование репозитория

Для доступа к паккейджам репозитория:

1. Слонировать репозиторий

2. В корневой папке репозитория выполнить:

   pip install -e ./

3. Дождаться вывода об успешной установке в консоль:

   Installing collected packages: hdl-py-pkgs
     Running setup.py develop for hdl-py-pkgs
   Successfully installed hdl-py-pkgs