Recent

Author Topic: I can write your README.md file 4 you 4 free  (Read 5315 times)

schuler

  • Sr. Member
  • ****
  • Posts: 265
I can write your README.md file 4 you 4 free
« on: May 14, 2025, 06:13:36 am »
Hello.

I am currently testing a prototype that writes README.md files for pascal projects with up to 50k lines of pascal code. The prototype itself is NOT coded in pascal but I paid attention to make it work for creating READMEs for pascal based projects. At this moment, the AI engine behind the prototype is Gemini 2.5 Flash.

If you have a free pascal/lazarus project needing a new README file on github, just share your project URL here. Your project will be used in my testing ( I hope that I will not be flooded ). Then, I'll give a go with my prototype. If all good, I'll send you a pull request via github with the updated README.md version.

:) Happy Lazarus/Pascal Coding :)

MarkMLl

  • Hero Member
  • *****
  • Posts: 8431
Re: I can write your README.md file 4 you 4 free
« Reply #1 on: May 14, 2025, 08:43:38 am »
Oh God NO FFS!

Look. I'm sure that what you've done is very clever, but the overall project has such enormous problems with incomplete and unindexed RTL and FCL documentation (LCL really being a separate issue) that the last thing we need is to attract criticism because members of the community are putting equally-useless summaries on Github.

I attempted a permuted index of the libraries a few months ago which Marco rejected because it was largely in Perl. If you want to do something /helpful/ then tackle the problem of "how do I do such-and-such", it might be that he'll be happier with something which can claim an "AI" heritage.

MarkMLl

MT+86 & Turbo Pascal v1 on CCP/M-86, multitasking with LAN & graphics in 128Kb.
Logitech, TopSpeed & FTL Modula-2 on bare metal (Z80, '286 protected mode).
Pet hate: people who boast about the size and sophistication of their computer.
GitHub repositories: https://github.com/MarkMLl?tab=repositories

Thaddy

  • Hero Member
  • *****
  • Posts: 17176
  • Ceterum censeo Trump esse delendam
Re: I can write your README.md file 4 you 4 free
« Reply #2 on: May 14, 2025, 08:50:54 am »
Well, Schuler has a PhD in AI, Mark.... He is a Doctor in CS. I for one, will look at it and try to find a bit of my code that needs an md (not medical doctor).
Seems he has a new job  :D ;) O:-) 8-) Is there a need for disclosure of interest?  ::)

Oh, about killer software written in FPC - from another thread - , much of his published code satisfies just that:
Extremely well written AI software in FPC.

I will find something, Joao.
« Last Edit: May 14, 2025, 07:13:09 pm by Thaddy »
Due to censorship, I changed this to "Nelly the Elephant". Keeps the message clear.

schuler

  • Sr. Member
  • ****
  • Posts: 265
Re: I can write your README.md file 4 you 4 free
« Reply #3 on: May 14, 2025, 09:36:38 am »
@Thaddy,
Thank you so much for your support. It motivates me to code in pascal...

Quote
Is there a need for disclosure of interest?

I need to test the "prototype" with open source pascal code so I can safely produce READMEs.

Quote
I will find something, Joao.

Looking forward to contribute with a README.md file.

cdbc

  • Hero Member
  • *****
  • Posts: 2208
    • http://www.cdbc.dk
Re: I can write your README.md file 4 you 4 free
« Reply #4 on: May 14, 2025, 09:48:27 am »
Hi Joao
Intriguing, Here's an old test-project, made in a hurry and not big...
You can have a go at it, HERE.
Regards Benny
If it ain't broke, don't fix it ;)
PCLinuxOS(rolling release) 64bit -> KDE5 -> FPC 3.2.2 -> Lazarus 3.6 up until Jan 2024 from then on it's both above &: KDE5/QT5 -> FPC 3.3.1 -> Lazarus 4.99

schuler

  • Sr. Member
  • ****
  • Posts: 265
Re: I can write your README.md file 4 you 4 free
« Reply #5 on: May 14, 2025, 10:05:05 am »
@cdbc, repo accepted!

wp

  • Hero Member
  • *****
  • Posts: 12866
Re: I can write your README.md file 4 you 4 free
« Reply #6 on: May 14, 2025, 04:04:13 pm »
Just stumpled across this one of mine: https://github.com/wp-xyz/UnitConv

schuler

  • Sr. Member
  • ****
  • Posts: 265
Re: I can write your README.md file 4 you 4 free
« Reply #7 on: May 14, 2025, 08:11:45 pm »
@wp, repo accepted! :)

schuler

  • Sr. Member
  • ****
  • Posts: 265
Re: I can write your README.md file 4 you 4 free
« Reply #8 on: May 14, 2025, 11:12:24 pm »
@cdbc,
This is the pull request: https://github.com/cdbc-dk/diary/pull/3 .
This is how it looks: https://github.com/joaopauloschuler/readme-diary .

Disclaimer
I did 2 manual changes on the top of the AI generated README.md:
* I removed a wordy introduction.
* I took the suggested future improvements from an intermediate state and placed it into the final version.

schuler

  • Sr. Member
  • ****
  • Posts: 265
Re: I can write your README.md file 4 you 4 free
« Reply #9 on: May 14, 2025, 11:24:01 pm »

cdbc

  • Hero Member
  • *****
  • Posts: 2208
    • http://www.cdbc.dk
Re: I can write your README.md file 4 you 4 free
« Reply #10 on: May 15, 2025, 12:15:59 am »
Hi Joao
WOW, Ain't that the coolest README I've seen in a long time \o/ Kudos.
Thanks mate  ;)
Regards Benny
If it ain't broke, don't fix it ;)
PCLinuxOS(rolling release) 64bit -> KDE5 -> FPC 3.2.2 -> Lazarus 3.6 up until Jan 2024 from then on it's both above &: KDE5/QT5 -> FPC 3.3.1 -> Lazarus 4.99

PeterBB

  • Jr. Member
  • **
  • Posts: 71
Re: I can write your README.md file 4 you 4 free
« Reply #11 on: May 15, 2025, 12:56:50 am »
...
If you have a free pascal/lazarus project needing a new README file on github,  ....

Hi,

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

Regards,
Peter

schuler

  • Sr. Member
  • ****
  • Posts: 265
Re: I can write your README.md file 4 you 4 free
« Reply #12 on: May 15, 2025, 01:06:35 am »
Quote
does it have to be GitHub?  I have a few projects on SourceForge and GitLab.
Feel free to send.

wp

  • Hero Member
  • *****
  • Posts: 12866
Re: I can write your README.md file 4 you 4 free
« Reply #13 on: May 15, 2025, 01:25:28 am »
@wp,
This is the pull request: https://github.com/wp-xyz/UnitConv/pull/3 .
This is how it looks now: https://github.com/joaopauloschuler/readme-UnitConv
I am strongly impressed, I would never have thought of such a thorough description of this little tool. How did the AI create the formulas? Were they just copied from some of the comments, or did it analyze the code?

If you don't mind, here's another one: https://github.com/wp-xyz/CapaCalc. Very specific, of little general interest. I would be interested how the formulas are handled here. IIRC, there are no formulas in comments, only in bitmapped images... (and in the source code, of course). Maybe, please remove all text from the README.md and leave only the screenshot.
« Last Edit: May 15, 2025, 01:27:36 am by wp »

schuler

  • Sr. Member
  • ****
  • Posts: 265
Re: I can write your README.md file 4 you 4 free
« Reply #14 on: May 15, 2025, 06:43:17 am »
:)    :)
@wp,
The new pull request: https://github.com/wp-xyz/CapaCalc/pull/1 .
How it looks: https://github.com/joaopauloschuler/readme-CapaCalc .

Quote
How did the AI create the formulas?
Thanks to the underlying language model. Language models do well with equations.

Quote
Were they just copied from some of the comments, or did it analyze the code?
Both. The full source code is used.
 :)  :)
« Last Edit: May 15, 2025, 06:47:07 am by schuler »

 

TinyPortal © 2005-2018