I can write your README.md file 4 you 4 free

[avra]

Not everyone needs such a high level of detail. An option to change it could be useful.

Another option could be to include mermaid diagrams in LLM instructions.

If you do not already have a project name, LazyMD would be a nice fit 

[wp]

The new pull request: https://github.com/wp-xyz/CapaCalc/pull/1 .
How it looks: https://github.com/joaopauloschuler/readme-CapaCalc .

Again, very impressive. Sometimes even "scary", because the AI mentions possible use cases and gives advice how to extend the application to other calculation models - I would say, it must have "understood" the purpose of the program. It even makes a proposal how to improve the user interface!

I agree with avra that the text appears to be a bit too verbous for an introductory text to the application, it reads more or less like a full documentation. Therefore, it would be great if the verbosity could be controlled. And if I would have written the text I would have given the chapter "Supported Capacitance Calculations" more weight and would have moved it before the chapter "Core units and string resource" (which I probably would have dropped altogether).

Returning to the formulas: In this application, formulas are given explicitly only in bitmap images displayed in the forms. Does the AI do some kind of OCR to read the formulas from these images?

There seems to be a MathML issue in the formula of section "Capacitors in Series".

[cdbc]

Hi Joao
If you don't mind, could you try THIS, the first one was so well written, that I think I can actually use it as documentation for this one, which has a functioning Readme.md...
TIA
Regards Benny

[PeterBB]

does it have to be GitHub?  I have a few projects on SourceForge and GitLab.

Feel free to send.

https://sourceforge.net/projects/c-evo-eh/
https://sourceforge.net/projects/cevomapgen/

Cheers,
Peter

[schuler]

 

As readmes are produced, I am enjoying a lot looking at your projects. There is so much cool code in pascal...

I would say, it must have "understood" the purpose of the program. It even makes a proposal how to improve the user interface!

Agreed.

I agree with avra that the text appears to be a bit too verbous for an introductory text to the application, it reads more or less like a full documentation. Therefore, it would be great if the verbosity could be controlled.

Will add configuration for it. I prefer the verbose side as it helps me understanding projects that I had never seen before.
 

Returning to the formulas: In this application, formulas are given explicitly only in bitmap images displayed in the forms. Does the AI do some kind of OCR to read the formulas from these images?

At this point in time, the "prototype" (I'll need to give a name to this project) does not have any vision/OCR capacity. So, everything that it does is text based.

There seems to be a MathML issue in the formula of section "Capacitors in Series".

It will never be perfect. Human revision will always be a requirement. I've just manually fixed the PR with the addition of 2 CR/LF entries.

@cdbc and @PeterBB, your last repos have been accepted for testing.

[Fred vS]

Hopa Joao!

Very, very impressed.

But would it be possible for your AI to recognize how programs work and provide a description without having a readme.txt file as inspiration?

And can it check a GitHub project with many projects/directories?

What if these projects use the MSEgui widget set? (https://github.com/mse-org/mseide-msegui)

GitHub-addition already performs a check after each commit, compiles each project, and provides a report on all projects, whether they compile correctly or not.

Of course, GitHub doesn't test it, it just compiles it.

There are about 300 projects, with no description, or very few, except in the sources.
I admit I'll never find a human to do this immense task.

Here's the GitHub site that would be honored to be reviewed:
https://github.com/mse-org/mseuniverse

Fre;D

[GAN]

This is really impressive.
Question (possibly a stupid question): Can Gemini create a program based on the Readme.md file? I mean a readme.md like the ones from WP.

[PeterBB]

@PeterBB, your last repos have been accepted for testing.

Thanks Joao, fascinating.

As others have said, a bit verbose for a basic README,
but the "Technical Architecture Overview" very useful
for developers rather than users. I would suggest putting it at the end,
rather than before "Installation" and "Usage",
maybe in an appendix or even its own separate document.

I'd be very interested to see the "Technical Architecture Overview" for
c-evo-dh.  I'm not the original author and this would be very helpful
in navigating the code base. Is there a problem with this one?


Something I noticed about this README, the application main form is tabbed.
However, only the first, main tab is mentioned. All tabs should ideally be
documented (as in Docs/Reference.html). Was something truncated here?


Another bit of this README seemed a bit weak; "Obtaining the Source Code:"

"Get the project source code. In the context of this task, the source code is already provided to you.
In a typical scenario, this would involve cloning a Git repository or downloading a source archive."

TBF, I realise this tool is configured for GitHub,
and possibly does not scrape SourceForge too well.
Also, my own comments on the site aren't great either!

Source forge projects contain a "Code" tab that has
a "Download Snapshot" and "Git clone" instructions,
which could be used for more specific suggestions.

BTW, if it is useful for your testing, this project is also on GitLab.
https://salsa.debian.org/PeterB/cevomapgen

Regards,
Peter

[wp]

Joao, can I ask you for another one? https://github.com/wp-xyz/ETrace. I would be interested in how well the AI is able to guess the purpose of the program. Therefore, I removed an already existing, very short README text which gave some hints (hopefully the AI will not look into the github history...).

[schuler]

  Hello

Many thanks for your submissions! Besides creating readmes, I can see so much cool code that otherwise I would not be aware about!

Based on your feedback and on the bugs that popped at my end while running, I'm now coding the next version. Therefore, the next readmes will need to wait for the next version of the "prototype".

@Fred,

There are about 300 projects, with no description, or very few, except in the sources.
I admit I'll never find a human to do this immense task.

I am honored to be challenged. I'll put this into consideration. I like challenges.

@GAN,

Can Gemini create a program based on the Readme.md file? I mean a readme.md like the ones from WP.

This is an intelligent thought/question. You can test this idea directly at: https://gemini.google.com/app .

The "prototype" uses a mix of evolutive computation, genetic algorithms and LLMs. The LLM is a big building block but it is not everything. BTW, I'll certainly open source the "prototype".

@Peter,

realise this tool is configured for GitHub,
and possibly does not scrape SourceForge too well.

The "prototype" does a git clone of the repo and then scans for all .pas, .pp, .lfm, .lpr, .inc, .md, .txt files (among few other file types). So, the origin is not important.

@wp,

can I ask you for another one? https://github.com/wp-xyz/ETrace.

You certainly can ask. I will look at it once the next version is ready.

wish everyone a nice weekend

[schuler]

@PeterBB, the AI generated readme: https://github.com/joaopauloschuler/READMEs/blob/main/READMEs/c-evo-eh.md

In this experiment/test, only the pascal interfaces were used. The full source code was not used.

[schuler]

@Fred, this is the readme for one of the code examples: https://github.com/joaopauloschuler/readme-mseuniverse/tree/main/samples/BGRABitmap/fractal_tree .

[schuler]

It is time for me to open source the “prototype”! This is it:
https://github.com/joaopauloschuler/beyond-python-smolagents/

All examples in this forum thread were made with "Use heavy thinking" and a paid Gemini API account (v2.5 Flash).

[cdbc]

Hi Joao
Just curious, didn't your tool succeed with my second project, or wasn't my project good enough?
Oh, and please use the full source...
Regards Benny

[Fred vS]

@Fred, this is the readme for one of the code examples: https://github.com/joaopauloschuler/readme-mseuniverse/tree/main/samples/BGRABitmap/fractal_tree .

WOW,  many thanks Joao.