GitHub — различия между версиями

Версия 08:48, 15 ноября 2018

Централизованный аккаунт: @gpn-polytech

По адресу почты @spbstu.ru можно оформить студенческий аккаунт.

Приложение: GitHub Desktop.

Участники

• Антонов Илья – @antoidco
• Калюжнюк Александр – @iomguy
• Краева Светлана – @svetlanakraeva
• Лапин Руслан – @FanOfRammstein
• Марков Николай – @mksfmksf
• Мурачёв Андрей – @anewmur
• Мущак Никита – @NikitaMushchak
• Осокина Алена – @ElaineEddington
• Старобинский Егор – @starobinskii
• Хлопин Сергей – @hlserg
• Цветков Денис – @AHuxley
• Шварёв Николай – @megameowmeow

Проекты

Сборка программ

Помимо собственных кодов программе могут требоваться сторонние библиотеки, настройка переменных окружения (среды) и определённым образом заданные входные файлы. Возложение ответственности за это на конечного пользователя чревато ошибками, к примеру, из-за несовместимости версий используемых файлов. Проблема обостряется при параллельной разработке различных модификаций ПО, изменении имён файлов и т. д. Правильным решением видится применение средств автоматической сборки программ.

Автоматическая сборка

Режим дебага

C/C++

Python

Программа PyInstaller позволяет собирать python-проекты в исполнительные файлы на разных платформах (включая Windows, Linux, macOS), автоматически подгружая необходимые библиотеки. Модификация исходного кода не требуется. Доступна сборка графических интерфейсов (Qt4, Qt5, wxWidgets, GTK) без консольного окна. Собранный проект не будет зависеть от того, установлен ли python нужной версии и требуемые библиотеки на компьютер пользователя.

Создание установщика

С помощью NSIS можно создавать программы-установщики для Windows (installer и uninstaller). Если платформа сборки установщика не Windows, потребуется компиляция NSIS из исходников. Существуют аналогичные решения для сборки установщиков под другие системы.

Проверка сборки

Тестирование

Документация

Markdown

Markdown – язык разметки, широко используемый в git-репозиториях. Текстовым файлам, написанным с использованием markdown принято присваивать расширение .md.

Традиционно репозитории содержат следующие файлы:

• README.md – описание проекта, процедур сборки, установки и использования ПО, ссылки на авторов и документацию;
• CHANGELOG.md – описание изменений между разными версиями ПО.

Файлы с разметкой markdown с помощью doxygen могут быть преобразованы в отдельные страницы документации.

Doxygen

Doxygen — гибкий инструмент генерации программной документации по исходному коду.

По умолчанию doxygen поддерживает C++, Python и другие языки (список возможностей). Также есть ряд расширений, добавляющих поддержку Matlab, позволяющих интегрировать doxygen в Visual Studio и др.

В первую очередь следует использовать doxygen доя генерации html. Если для формальной отчётности требуется оформить документацию на программное обеспечение, без дополнительных изменений кода программы doxygen позволяет пересоздать документацию в виде rtf-файла (с автоматической нумерацией и программируемыми полями), который затем можно открыть в Microsoft Word и сохранить в нужный формат.

Также doxygen содержит компилятор latex, что позволяет дополнять документацию формулами.