search

bigbigmdm / IMSProg

IMSProg - software for CH341A-based programmers to work with I2C, SPI and MicroWire EEPROM/Flash chips
https://antenna-dvb-t2.ru/IMSProg.php
GNU General Public License v3.0
196 stars 34 forks source link

README.md fix "What is this" #55

Open AndreiCherniaev opened 5 months ago

AndreiCherniaev commented 5 months ago

Description

What is different between EZP2019-EZP2025_chip_data_editor and IMSProg editor?

I want to fix README.md text "IMSProg - Linux IMSProg - I2C, MicroWire and SPI EEPROM/Flash chip programmer for CH341A devices. The IMSProg is a free programmer tool based on QhexEdit2 and modified SNANDer programmer.

This is a GUI program used widget QhexEditor. For setting the SPI chip parameters you can use the Detect button for reading chip parameters (JEDEC information reading) or manually setting it. The I2C and MicroWire EEPROM only manually selected." Looks like this repo contains two different programs: programmer and editor. If so then you should describe the programmer and describe the editor...

P.S. Please use English or Russian.

Usage tips

bigbigmdm commented 5 months ago
  1. What is different between EZP2019-EZP2025_chip_data_editor and IMSProg editor?
    • only field names and folder search algorithm.
  2. You're right. The editor should also be described, for example as here.
AndreiCherniaev commented 5 months ago

  1. What is different between EZP2019-EZP2025_chip_data_editor and IMSProg editor?

    • only field names and folder search algorithm.
    1. You're right. The editor should also be described, for example as here.

Я изучил ссылку. "Формат базы данных микросхем основан на формате программаторов EZP2019, EZP2020, EZP2023, Minpro I, XP866+. Для ее редактирования используется отдельный компонент программы." Компонент программы - звучит очень непонятно. Также вы говорите "Программа IMSProg". То есть в вашем мире есть программа IMSProg и она делится на два компонента: programmer, data base editor.

Я такого не встречал. Давайте рассмотрим какой-нибудь классический пример, да ещё и англоязычный. Если переводить на вашу разработку термины из То получается что у вас есть collection of tools - набор утилит 1) Утилита programmer - programmer tool 2) Утилита data base editor - data base editor tool (или для краткости editor tool)

Давайте примем такую терминологию?

bigbigmdm commented 5 months ago
  1. Есть еще скрипт обновления базы.

Кое-что я писал в man по каждому из компонентов. Давайте применим эту терминологию, но programmer - главная утилита, может жить самостоятельно, а остальные лишь делают работу с programmer более комфортной.

AndreiCherniaev commented 5 months ago

  1. What is different between EZP2019-EZP2025_chip_data_editor and IMSProg editor?

    • only field names and folder search algorithm.

So users shouldn't use EZP2019-EZP2025_chip_data_editor because it is deprecated. Users should use IMSProg instead. Correct?

bigbigmdm commented 5 months ago

@AndreiCherniaev EZP2019-EZP2025_chip_data_editor используется для других программаторов - EZP2019 - EZP2025. У них только софт под Windows. Изначально я хотел написать программу под Linux для них, но у них закрытый код и его не заполучить. Мне понравился формат данных их базы микросхем и я использовал его в IMSProg, немного изменив "под себя" в процессе доработки программы.

bigbigmdm commented 5 months ago

@AndreiCherniaev , я добавил информацию в README. Вы посмОтрите?

AndreiCherniaev commented 5 months ago

Кое-что я писал в man по каждому из компонентов. Давайте применим эту терминологию

Я вас не понимаю. Мы вчера кажется сошлись на том, что IMSProg is a collection of tools: но вы пишите "IMSProg consists of three executable modules:" Поэтому я смущён...

bigbigmdm commented 5 months ago

Поправил. Сейчас картинок накидаю и можно будеть исправлять.

AndreiCherniaev commented 5 months ago

@AndreiCherniaev EZP2019-EZP2025_chip_data_editor используется для других программаторов - EZP2019 - EZP2025. У них только софт под Windows. Изначально я хотел написать программу под Linux для них, но у них закрытый код и его не заполучить. Мне понравился формат данных их базы микросхем и я использовал его в IMSProg, немного изменив "под себя" в процессе доработки программы.

image Can you add link https://antenna-dvb-t2.ru/EZP_programmers.php in github's "Website" field? P.S. Please use "Qt" not "QT".

bigbigmdm commented 5 months ago

В моем профиле есть сайт, или Вы имеете ввиду в другом месте?

AndreiCherniaev commented 5 months ago

В моем профиле есть сайт, или Вы имеете ввиду в другом месте?

Я про вот это место, сюда добавить https://github.com/bigbigmdm/EZP2019-EZP2025_chip_data_editor Can you add link https://antenna-dvb-t2.ru/EZP_programmers.php in github's "Website" field? 2) Please use "Qt" not "QT".

image

bigbigmdm commented 5 months ago

@AndreiCherniaev В первом приближении README готово. Можете посмотреть?

AndreiCherniaev commented 5 months ago

@AndreiCherniaev В первом приближении README готово. Можете посмотреть?

Ох у меня такая проблема что из-за незакрытого моего реквеста мои новые реквесты объединяются с незакрытым... https://github.com/bigbigmdm/IMSProg/pull/57/commits/0542ae397e2019b71b6934a40cb8a63237755f6d

AndreiCherniaev commented 5 months ago

@AndreiCherniaev В первом приближении README готово. Можете посмотреть?

Сейчас думаю над этим текстом IMSProg - Linux IMSProg - I2C, MicroWire and SPI EEPROM/Flash chip programmer for CH341A devices.

То есть IMSProg - Linux only? А почему так? Вроде Qt позволяет быть на всех платформах...

bigbigmdm commented 5 months ago

@AndreiCherniaev Так, вроде, все слилось как надо?

AndreiCherniaev commented 5 months ago

@AndreiCherniaev Так, вроде, все слилось как надо?

yes

bigbigmdm commented 5 months ago

@AndreiCherniaev "То есть IMSProg - Linux only? А почему так? Вроде Qt позволяет быть на всех платформах..." - под Windows это целая история с неподписанными драйверами на CH341A, под Linux они уже есть в ядре. Под MAC - не знаю... Под Android - практически нет устройств с USB-A да еще и в режиме OTG и без root там правило не добавить.

bigbigmdm commented 5 months ago

@AndreiCherniaev , как закончите с README, дайте знать. Я сделаю новый таг и выпущу release

AndreiCherniaev commented 5 months ago

@AndreiCherniaev , как закончите с README, дайте знать. Я сделаю новый таг и выпущу release

У меня такая идея. Уже имеются разделы "Chip database editor" и "Chip updater". А почему нет раздела "chip programmer"? Похоже надо сделать раздел "chip programmer" и перенести туда текст

For setting the SPI chip parameters you can use the Detect button for reading chip parameters (JEDEC information reading) or manually setting it. The I2C and MicroWire EEPROM only manually selected.

The chip database format is clone with EZP2019, EZP2020, EZP2023, Minpro I, XP866+ programmers. You can edit the database use the EZP Chip data Editor

CH341A EEPROM programmer

CH341A EEPROM programmer

А также всё что написано в разделе "## How to use:" до раздела "## Chip database editor"

Правилньо я думаю?

bigbigmdm commented 5 months ago

По сути перед "How to use:" нужно добавить Chip_programmer или IMSProg_programmer.

Сделаете, вместе с коррекцией предыдущего pull request?

AndreiCherniaev commented 5 months ago

По сути перед "How to use:" нужно добавить Chip_programmer или IMSProg_programmer.

Допустим перед "How to use:" добавлю "IMSProg_programmer". А вот этот текст разве не нужно перенести в этот новый раздел "IMSProg_programmer"?

For setting the SPI chip parameters you can use the Detect button for reading chip parameters (JEDEC information reading) or manually setting it. The I2C and MicroWire EEPROM only manually selected.

The chip database format is clone with EZP2019, EZP2020, EZP2023, Minpro I, XP866+ programmers. You can edit the database use the EZP Chip data Editor

И вот эти пикчи перенести в новый раздел? CH341A EEPROM programmer

CH341A EEPROM programmer

bigbigmdm commented 5 months ago

Посмотрите, как сейчас: How to use --> chip programmer

AndreiCherniaev commented 5 months ago

Посмотрите, как сейчас: How to use --> chip programmer

Я считаю что "How to use:" вообще лишний... Но это не принципиально... С текстом-то что делать?

bigbigmdm commented 5 months ago

"How to use:" я бы оставил для удобства навигации.

"For setting the SPI chip parameters you can use the Detect button for reading chip parameters (JEDEC information reading) or manually setting it. The I2C and MicroWire EEPROM only manually selected." - дубляж информации Chip type selecting - может совсем убрать?

"The chip database format is clone with EZP2019, EZP2020, EZP2023, Minpro I, XP866+ programmers. You can edit the database use the EZP Chip data Editor" - можно оставить на старосм месте. По сути - информация по используемому формату.

AndreiCherniaev commented 5 months ago

"For setting the SPI chip parameters you can use the Detect button for reading chip parameters (JEDEC information reading) or manually setting it. The I2C and MicroWire EEPROM only manually selected." - дубляж информации Chip type selecting - может совсем убрать?

Согласен, убирайте!

можно оставить на старосм месте.

Согласен!

AndreiCherniaev commented 5 months ago

@bigbigmdm А с какой целью в README.md существует img/1_8_adapter.png ? Это же не просто иллюстрация? Я вот спустя три дня начал подозревать, что img/1_8_adapter.png - это пример как может выглядеть адаптер на 1.8Вольта. Это так? Может тогда подпишем эту пикчу? Вот как это можно сделать


<p align="center">
  <img src="img/1_8_adapter.png">
  <br>
    <em>1.8 V adapter pcb</em>
</p>
bigbigmdm commented 5 months ago

@AndreiCherniaev , мне кажется,это лишнее. Текст выше рассказывает об этом адаптере, на плате написано, что это такое.

AndreiCherniaev commented 5 months ago

@AndreiCherniaev , мне кажется,это лишнее. Текст выше рассказывает об этом адаптере, на плате написано, что это такое.

ok. Я правда не согласен что текст выше рассказывает ОБ ЭТОМ адаптере... Текст расказывает о неком адаптере... Нет, не очевидно что на пикче ниже именно он... Ну да и ладно...

What about this images ![CH341A black](img/ch341_black150.png) ![CH341A green](img/ch341_green150.png) Может быть надо их подписать? К чему они вообще указаны?

bigbigmdm commented 5 months ago

@AndreiCherniaev мы доредактировались с Вами. Из шапки пропало, что это программа для для программатора CH341A.

bigbigmdm commented 5 months ago

Это должно идти первым предложением.

AndreiCherniaev commented 5 months ago

Это должно идти первым предложением.

IMSProg - I2C, MicroWire and SPI EEPROM/Flash chip Programmer - is a program to read, write EEPROM chips using programmers based on CH341A.

Good?

bigbigmdm commented 5 months ago

Good!

bigbigmdm commented 5 months ago

Я поднял картинку и опустил фразу о форматах. Теперь понятно, для чего она.

AndreiCherniaev commented 5 months ago

Я поднял картинку и опустил фразу о форматах. Теперь понятно, для чего она.

Я могу только догадываться, что это Example of programmers based on CH341A Так?

AndreiCherniaev commented 5 months ago

А вот эти картинки - это про что? Не надо ли их перенеси в "Chip programmer"?

![CH341A EEPROM programmer](img/IMSProg_1.png)
![CH341A EEPROM programmer](img/IMSProg.png)
bigbigmdm commented 5 months ago

Люди, которые этим занимаются знают эти картинки лучше нас с Вами. Это не существенно. И должны они быть сверху, чтобы сразу было видно о чем речь.

bigbigmdm commented 5 months ago

Поверьте, эту программу на Linux ждали около 10 лет

AndreiCherniaev commented 5 months ago

Люди, которые этим занимаются знают эти картинки лучше нас с Вами. Это не существенно. И должны они быть сверху, чтобы сразу было видно о чем речь.

ok

bigbigmdm commented 5 months ago

@AndreiCherniaev мне кажется, что у нас с Вами хорошо получилось. Еще бы man файлы посмотреть...

AndreiCherniaev commented 5 months ago

man файлы

Give link please...

bigbigmdm commented 5 months ago

1 2 3

AndreiCherniaev commented 5 months ago

1 2 3

How I can make commit here?

bigbigmdm commented 5 months ago

Download -> unzip -> edit ->zip->upload It is a standard man document.

AndreiCherniaev commented 5 months ago

Download -> unzip -> edit ->zip->upload It is a standard man document.

И как вы будете мои изменения отсматривать? Разжимать у себя обратно и сравнивать? How another software host man files? I believe should be better solution...

bigbigmdm commented 5 months ago

Это одноразовая акция, так что да. Эти файлы, я надеюсь, меняться не будут.

AndreiCherniaev commented 5 months ago

Это одноразовая акция, так что да. Эти файлы, я надеюсь, меняться не будут.

Сначала я увижу 2 недостатка и поправлю. Через час ещё два. Завтра ещё. И каждый раз unzip-zip. Очень грустно. Надо бы узнать как другие проекты это автоматизируют и тоже автоматизировать?

bigbigmdm commented 5 months ago

Это номинальные файлы, дающие краткую информацию и отсылающие к index.html. Чисто теоретически можно их жать с помощью cmake.

bigbigmdm commented 5 months ago

@AndreiCherniaev просто lintian сообщил в предупреждениях о необходимости man инструкций, которые для GUI программы мало интересны, но традиция... Вот генерация Index.html меня сейчас занимает больше. Поскольку он создан на основе README.md и чтобы не тащить за собой три десятка картинок я вставил их внутрь документа в base64. Fantu нашел инструмент, который хорошо конвертирует readme в html, но изображения в bsd64 он не переводит.

AndreiCherniaev commented 5 months ago

Это номинальные файлы, дающие краткую информацию и отсылающие к index.html. Чисто теоретически можно их жать с помощью cmake.

For me also not clear what next. For now you keep *.1.gz in repo. But what are you doing with its?

Let's exclude .gz files from repo? Let's keep only .1 files?

bigbigmdm commented 5 months ago

@AndreiCherniaev их нельзя исключать. Они копируются в систему при установке. Давайте пока оставим их в покое.