AmirHmZz / mpbridge

CLI tool to synchronise and manage files on MicroPython running devices
https://pypi.org/project/mpbridge
MIT License
49 stars 5 forks source link

Added some --help description text, and revised some hint text. #21

Closed Wind-stormger closed 1 year ago

Wind-stormger commented 1 year ago

Workflow in development mode, Sync file and Clean Sync file are detailed in --help.

Wind-stormger commented 1 year ago

Time to update to PyPI 😄

Wind-stormger commented 1 year ago

I have drawn a flowchart.

mpbridge.drawio.svg

Wind-stormger commented 1 year ago

You may be busy with other things~

Check it out if you have free time 😉

AmirHmZz commented 1 year ago

Thanks for doing this nice job! I've also checked the flowchart and it seems fine! Would you please add flowchart to readme.md in dev mode instruction?

Wind-stormger commented 1 year ago

Wind-stormger commented 1 year ago

Which typography would be suitable, perhaps portrait?

AmirHmZz commented 1 year ago

Thanks! I think the landscape one is more compact and better to be viewed in desktop.

Wind-stormger commented 1 year ago

Done~

AmirHmZz commented 1 year ago

Thank you! I've reviewed your flowchart. I think it might be better to create a flowchart for sync command separately and add it too readme in sync section! Also it is better to have the -clean flag in sync flowchart too.

Wind-stormger commented 1 year ago

AmirHmZz commented 1 year ago

Thanks :)