search

writeme-project / writeme

Cross-platform README.md generator
GNU General Public License v3.0
14 stars 0 forks source link

How it works section in depth #48

Closed ilcors-dev closed 1 year ago

ilcors-dev commented 1 year ago

Maybe we should add a section in the readme file of the project that illustrates a little bit deeper how the application works starting from the parsing of known config files, the merging of conflicting attributes and the assembly of the information gathered

BabelDev0 commented 1 year ago

Good idea. I wrote something here that we can take a cue from, but in the README file maybe we want to have a more concise and direct writing style

ilcors-dev commented 1 year ago

sounds good, we could but a link in the readme file then

BabelDev0 commented 1 year ago

Maybe I would write two concise lines and then put the link to the wiki to learn more. It might not be a bad idea to also include a GIF demo of what you could achieve with the program (eg https://github.com/kotartemiy/pygooglenews)