Skip to content

Created a README.#2

Open
Amaroq-Clearwater wants to merge 4 commits intothpatch:masterfrom
Amaroq-Clearwater:master
Open

Created a README.#2
Amaroq-Clearwater wants to merge 4 commits intothpatch:masterfrom
Amaroq-Clearwater:master

Conversation

@Amaroq-Clearwater
Copy link

Disclaimer: The README in question is AI-generated, but it should still be reasonably accurate. You are welcome and encouraged to review it yourself.

Amaroq-Clearwater and others added 4 commits May 18, 2024 04:21
Disclaimer

This README was produced using ChatGPT and may contain errors in its content and/or formatting. Please verify the information and refer to the source code for the most accurate details.
Added Dependency information.
@brliron
Copy link
Member

brliron commented May 19, 2024

The text part or the readme isn't too bad. The features section is a bit redundant with the sentence above it, the prerequisites section feels a bit weird because a Windows program working on wine is, well, that's the point of wine, and a C++ library for Win32 requiring a C++ compiler compatible with Win32 is a given. The example section says almost the same thing as the usage section. And the License section is an hallucination from the AI, this project doesn't have a license.

And then I checked smartdlg.hpp to see if the example code makes sense.

AI:

SmartDlg dlg(hDlg);

smartdlg.hpp:

namespace SmartDlg {

AI:

dlg.addControl(IDC_BUTTON1, SMARTDLG_ANCHOR_LEFT | SMARTDLG_ANCHOR_TOP);

smartdlg.hpp:
Ctrl+F addControl => 0 results.
Ctrl+F SMARTDLG_ANCHOR_LEFT -> 0 results.

This is worthless. Actually, it's a lot worse than worthless. Without a readme, you go to smartdlg.hpp to try to understand how it works. With a readme like this, you waste time trying to make it work, get weird errors that don't make sense, and after wasting a decent chunk of time on that, you either go read smartdlg.hpp or give up on this project - with the 2nd one being probably more likely.

Also, while looking for an example code I could look at for this section, I noticed that we actually never used this code. https://github.com/thpatch/thcrap/blob/940dcb3612fb1013fa360ab64ca22ffd331df14f/thcrap_update/src/self.cpp still has a comment saying "I want to make that into a reusable library" instead of actually using smartdlg.

@Amaroq-Clearwater
Copy link
Author

Ah. So this example readme is no good, then…

Hopefully an official readme will be written at some point. Should I go ahead and close this PR?

@Amaroq-Clearwater
Copy link
Author

I guess I'll find somebody to help me clean it up, and make it actually usable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants