CudaText: реестр плагинов

uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

завтра тогда жду фиксов, и буду писать про список в моем вики.

>гифки демонстрации работы плагинов
Ну нет, это мне куча работы.
Shovel
Posts: 141
Joined: 31.12.2019 10:16

Post by Shovel »

Вроде все починил.
cyber_banat wrote:...Только добавь ещё CONTRIBUTING.md файл с описанием что делать, что бы пополнить список.
Правила оформления запросов, требования к репозиториям и запросам (хорошо бы требовать readme файл в репозитории, с описанием плагина)
@uvviewsoft этим наверное вы займетесь, так как вы заведуете плагинами?
(Скажете, если мне еще что-то нужно сделать если вы решите бразды правления списком взять)

uvviewsoft wrote:>гифки демонстрации работы плагинов
Ну нет, это мне куча работы.
Я может неясно выразился.
_Я_ хотел сделать гифки популярным плагинам и добавить их в README.md репозиториев через Pull Request (если я правильно понимаю что такое Pull request :) )

EDIT: Чуть не забыл, куда эти плагины поставить? Я не понял что они делают :)
Dash Help - Opens Dash help pages, for selected text or current word
Font Awesome - Search FontAwesome Icons in sidebar and insert the codes in editor.
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

Гифки-- не стОит время тратить, не думаю что кто-то ходит по ГХ страницам и смотрит там чтото в ридми которое к тому же ВТОРОЕ ридми

Dash-- программа поставки хелпов.
FontAwesome- это сайт такой!
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

В родном ридми описано же--
allows to call Dash help files (doc-sets) from CudaText. search is made from selected text, or current word if none is selected.
for macOS, you must install Dash app.
for Windows/Linux, install similar Zeal app, it uses Dash doc-sets too. https://zealdocs.org/
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

Добавил в главное вики-
https://wiki.freepascal.org/CudaText#Add-ons
cyber_banat
Posts: 23
Joined: 16.01.2021 23:04

Post by cyber_banat »

uvviewsoft wrote:Гифки-- не стОит время тратить, не думаю что кто-то ходит по ГХ страницам и смотрит там чтото в ридми которое к тому же ВТОРОЕ ридми

Dash-- программа поставки хелпов.
FontAwesome- это сайт такой!
Не согласен про ридми. Это самый важный файл в публичном репозитории. Репозиторий без ридми воспринимается многими как какой-то мусор или личные наработки, в общем что-то на изучение чего не стоит тратить время.

Awesome списки именно так и работают - читаем короткие описания, идём в репозиторий и смотрим что это из себя представляет. И из readme же и берутся описания для плагинов внутри редактора/менеджера пакетов и подобного.

Про гифки согласен, это только усложнит поддержку, а ещё и замедлит изучение списка из-за визуального мусора
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

ридми вы предлагаете+хотите сгенерировать новые? просто копируя readme\readme.txt в корень в markdown?
ну окей.
Гифки можно еще тоже тогда.
так лучше будет с гиф.
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

Гифки я имею в виду можно класть как добавку к readme.md в сами репо. А потом вы можете решить- брать из репо эти гифки. или нет. можно брать и показывать по клику на чем то.
cyber_banat
Posts: 23
Joined: 16.01.2021 23:04

Post by cyber_banat »

uvviewsoft wrote:ридми вы предлагаете+хотите сгенерировать новые? просто копируя readme\readme.txt в корень в markdown?
ну окей.
Гифки можно еще тоже тогда.
так лучше будет с гиф.
Да, просто скопировать. Но вообще я только сейчас узнал о директории readme.
А почему вообще было решено так спроектировать структуру директорий? Возможно это причина для пересмотра файловой структуры с документацией плагинов. Во всех git сервисах принято заводить в корне репозитория/сабрепозитория README.md файл.

Но вообще, если такой файл есть впринципе, даже где-то глубоко, то это ок, можно и не переносить, но я например даже не заметил его сразу, поэтому вынесение его в корень было бы более дружелюбным для навигации.

Если бы я был разработчиком этих плагинов, я бы выполнил простенький скрипт в консоли из комбинации mv && git commit -am && git push для такого рефакторинга структуры и вынесения файлов в корень репозитория
uvviewsoft
Posts: 392
Joined: 01.12.2020 13:46

Post by uvviewsoft »

>почему вообще было решено так спроектировать структуру директорий?
Там же в папке я кладу history.txt (его юзает Addon Manager). и все лицензии 3rd party. и иногда картинки еще тоже.
Все это в корне- не ОК
Post Reply