README

================================================================================
 Описание
================================================================================
Приложение kicadbom2spec создает файл перечня элементов в виде таблицы *.ods в
формате Open Document Format, оформленной согласно требованиям ЕСКД, используя
файл схемы в формате KiCad Schematic. Также позволяет редактировать поля
элементов схем и библиотек.

--------------------------------------------------------------------------------
 1. Файлы и папки
--------------------------------------------------------------------------------
archlinux         - каталог с файлами для создания пакетов для Archlinux:
    make_pkg.sh   - скрипт для создания пакета Archlinux;
    PKGBUILD      - конфигурационный файл для утилиты makepkg;
bitmaps           - каталог с изображениями для графического пользовательского
                    интерфейса:
    *.png         - иконки для панели инструментов и меню;
    icon.*        - иконки приложения;
CHANGELOG         - перечень изменений;
checkinstall      - каталог с файлами для создания пакетов для Debian:
    description-pak
                  - файл содержащий описание программы;
    install.sh    - скрипт с инструкциями по установке программы;
    kicadbom2spec.desktop
                  - desktop entry (freedesktop.org);
    make_deb.sh   - скрипт для создания пакета Debian;
complist.py       - модуль для работы с перечнем элементов;
controls.py       - модуль со специальными элементами управления;
COPYING           - лицензионное соглашение;
doc               - каталог с файлами справочного руководства:
    user_manual.adoc
                  - исходный файл руководства пользователя в формате
                    asciidoctor;
    user_manual.html
                  - справочное руководство;
    images        - каталог с изображениями для руководства пользователя;
gui.fbp           - исходный файл графического пользовательского интерфейса;
gui.py            - модуль графического пользовательского интерфейса;
kicadbom2spec.pyw - приложение на языке python;
kicadsch.py       - модуль для работы с файлами схем (*.sch) и библиотек
                    (*.lib);
patterns          - каталог с шаблонами таблиц перечня элементов:
    *.ods         - шаблоны для вывода в виде эл. таблицы;
    *.odt         - шаблоны для вывода в виде текстового документа;
README            - файл, который вы сейчас читаете;
sample            - каталог с файлами примера (см. справочное руководство):
    sample.lib    - библиотека элементов схемы;
    sample.pdf    - пример готового перечня элементов;
    sample.pro    - файл проекта KiCad;
    sample.sch    - файл схемы примера;
settings.ini      - конфигурационный файл программы со значениями по умолчанию;
version           - текстовый файл с номером версии программы;
windows           - каталог с файлами для генерации инсталлятора (Windows):
    kicadbom2spec_windows_installer.nsi
                  - NSIS скрипт инсталлятора для Windows;
    VesionCompare.nsh
                  - NSIS библиотека. Содержит функцию сравнения версий.

--------------------------------------------------------------------------------
 2. Требования
--------------------------------------------------------------------------------
Для работы программы необходимы следующие компоненты:
* python 3      >= 3.8  http://www.python.org/
* wxPython      >= 4.0  http://www.wxpython.org/
* odfpy         >=0.9.6 https://pypi.python.org/pypi/odfpy
· LibreOffice           http://www.libreoffice.org/
· opengostfont          OpenGostTypeB-Regular.ttf (скачать из интернета)

Примечание: * - обязательные компоненты; · - рекомендуемые компоненты.

--------------------------------------------------------------------------------
 3. Параметры
--------------------------------------------------------------------------------
Форма вызова:
python3 kicadbom2spec.pyw [-h] [-v] [schematic] [complist]

Параметры:

-h, --help
    Получить помощь по работе со скриптом и выйти.

-v, --version
    Получить версию программы и выйти.

позиционный параметр schematic
    Имя файла схемы в формате KiCad.

позиционный параметр complist
    Имя файла перечня элементов.

================================================================================