CLI Video of the Init-Command to improve readme.md

OpenForgeProject / ddev-woodoo-buildtools-magento

ddev Addon to build Magento projects without headache

GNU General Public License v3.0

8 stars 5 forks source link

CLI Video of the Init-Command to improve readme.md #37

Closed dermatz closed 1 month ago

dermatz commented 3 months ago

To help interested people better understand what woodoo actually is, a video of the CLI will introduce the process and be placed as a GIF video in the README.MD.

Morgy93 commented 3 months ago

There's an example at https://github.com/charmbracelet/gum/blob/main/README.md They have a GIF demo for every command.

Even though I don't like (long) GIF demos because you are not able to follow at your own pace. At least GitHub has a pause feature now for GIFs. That's nice.

dermatz commented 3 months ago

I think the goal is not to create a documentation with a gif, but to show that the tool uses an intuitive way to manage and build themes. I think it should not take longer than 10 seconds as a intro to the tool.

Are you fine with that approach?