README.md

iQ Programming CookBook (прототип)

Программа-копилка готовых решений по программированию. Каждое из решений сохранянется в виде записи отдельного текстового файла в формате markdown, с возможностью выделения блоков кода и подсветки синтаксиса. Умеет создавать новые решения (делать записи) — ными словами это полноценная записная книга специалиста (или студента, преподавателя) в которой он может сохранять готовые куски кода, хранить свои мысли по решениям или предположениям… А главное делиться своими наработками, публиковать их или пересылать по сети (как полностью, так и частично. По идее - это все что нужно от таких систем. Имеется возможность добавления картинок (скриншотов) прямо изх контекстного меню редактора.

Интересна в первую очередь начинающим программистам, студентам, преподавателям или специалистам пишущим одновременно на нескольких языках и не утруждающим себя запоминанием готовых конструкций (таким как мы).

Программа позволяет быстро находить решения по названию или его части (нескольким частям), по компоненту (одному или нескольким), по тэгу (одному или нескольким).

В случае, если найдена группа записей, удовлетворяющая условиям поиска, ее можно вывести в окно для просмотра. Полученное можно отправить на принтер или экспортировать в PDF, ODT или markdown форматы.

Всё хранятся в папке называемой коллекцией. В коллекции могут быть вложенные папки. Программа собирает коллекцию во всей иерархии папок из коллекции.

Коллекция решений

Хранится отдельно и может быть выгружена в отдельный репозиторий. Создается индивидуально каждым пользователем для себя.
Пример коллекции готовых решений

Расширенные возможности

Поскольку редактор работает с форматом markdown, то нам показалось правильным добавить в него поддержку расширения TOC (для вставки оглавления в нужном метсе текста напишите [TOC]). Это особенно удобно при экспорте отобранных по тегу (или иным условиям) перечней рецептов в файлы электронной документации. Кроме того, в программу встроена расширенная поддержка списков, таблиц, анностаций и сносок.

Требования

Программа написана на Python 3.7. Требует наличия PyQT5 и markdown. Кроме того ей требуется pygments

Установка

Скрипта установки нет и не будет. Все можно сделать ручками. Для этого:

  1. Поместить содержимое репозитория в постоянное место (туда, где вам будет удобно)
  2. Создать папку Решения iQ Programming CookBook в корне домашней папки текущего пользователя
  3. Поместить содержимое папки config репозитория в папку ~/.config/iQ_P_CookBook — это файлы конфигурации
  4. Создать .desktop файл для запуска программы и поместить его согласно требований вашей версии linux
  5. Дать права на исполнение скрипта программы
  6. Отредактировать файлы конфигурации… по необходимости и файл шаблона.


* если все настройки сделать как указано — можно использовать файл лежащий в корне репозитория

Настройка

Не требуется, однако что-то изменить можно в файлах из папки

~/.config/iQ_P_CookBook

стандартное содержимое этих файлов находится в папке config этого репозитория

Технические особенности

Это прототип! Кроме того - это форк iQRacipe, специально заточенный под программирование, поэтому настройки не стоит менять без особой надобности… ну вы понимаете…

Лицензия

MIT

Описание

Копилка готовых решений по программированию

Конвейеры
0 успешных
0 с ошибкой