4 ms·
I have one comment, and I hope it's not rude: There is too much text. Everywhere where you can put text, the author put a lot of it. Sentence after sentence, ra
by lionkor 3y ago
I have one comment, and I hope it's not rude: There is too much text. Everywhere where you can put text, the author put a lot of it. Sentence after sentence, rambling on. Coherently so, most of the time, sure, but just one after the other and not a single relevant screenshot for the first thousand words.
Something is not right here. Either this is a joung enthusiastic coder, which is probably the case, or there is so much text in order to convince you to try it.
The readme even has an about me section where the author introduces himself.
For some examples, scroll to random points in the readme and read a few paragraphs, then repeat what you just read.
- dilawar 3y agoLol. He is definitely not young as in inexperienced coder. He will definitely not going to win awards for barely sufficient documentation and docs organisation. Dude got a personality. I've followed the project when I was in college and used it in my personal project.
- baz00 3y agoI just scanned it. It's not an MVP for some product they want to attract investors. It's a tool. Which has documentation written by someone who wrote it. I hope this one is not rude too: are you sure you're just not afraid of having to read stuff rather than being spoon fed bullet points and steps?
- lionkor 3y agoGive me a wordcount on that readme, you'll see what I mean. If it was 1/3rd the length it'd still be one of the longest readmes ive ever read - and almsot all the ones ive read and written are by humans.
- ptx 3y agoI think the problem with the README is that it sounds more like a marketing brochure than documentation. It's full of slogans and weird illustrations comparing it to "Other Python GUIs".
- jbstack 3y agoI'll gladly take long but coherent documentation over poor or non-existent documentation. This is a strange thing to complain about in my opinion.
- lionkor 3y agoI usually (and maybe annoyingly) give negative feedback on both missing and overly talkative docs equally
- tjpnz 3y agoI found it delightful and appreciate the lengths the author went in explaining why this exists and the goals of the project. A breath of fresh air compared to the usual sea of boilerplate and links to proprietary chat apps I don't want to use.
- lionkor 3y agoI urge you to scroll to any point in the readme and read, and recount what you read, because most of it is repetetive and fluff for no (obvious to me) reason
- makeitshine 3y agoSeems fine to me. In fact, it seems way better than most docs. I don't get the issue you're having with this.
- bmitc 3y agoThere is a lot of non-information, for sure. For example, > Some programs are not well-suited for PySimpleGUI however. By definition, PySimpleGUI implements a subset of the underlying GUI frameworks' capabilities. It's difficult to define exactly which programs are well suited for PySimpleGUI and which are not. It depends on the details of your program. Duplicating Excel in every detail is an example of something not well suited for PySimpleGUI. says absolutely nothing and gives the reader no useful leads as to the applicability of the framework to their project.
- aebtebeten 3y agoThat's the key part of the entire README; I found it very well put. tl;dr: "you will be disappointed if you want to do something fancy" (of course, should you want all three of (a) easy, (b) fancy, and (c) someone else has already done much of it for you, I'd bet you would be bound for disappointment anyway)
- bmitc 3y ago
- T-A 3y ago> Either this is a joung enthusiastic coder, which is probably the case From "About Me" [1] I've been writing software since the 70s. The majority of my career was spent creating products in Silicon Valley [1] https://github.com/PySimpleGUI/PySimpleGUI#about-me- https://github.com/PySimpleGUI/PySimpleGUI#about-me-
- sp0rk 3y agoI would say your comment is most definitely rude, especially the part where you reduce the reason for the text to two options, neither of which are very flattering. Incidentally, it seems like neither of your given reasons are accurate either. You could have gotten the same idea across by saying something like "This is a visual project so I feel like it should include more screenshots in the main description" and leaving the insulting assumptions out entirely.
- lionkor 3y agoThats not my main point, though - my point is that this rambling text doesnt work as a readme, for me, and i feel its much too long and has little content for the amount of text
- deleted 3y ago[deleted]
- dbsmith83 3y agoEach section has a clear heading. If you don't care about a section, all you have to do is scroll a little bit. No one is forcing you to read the "about me" section. Some people actually enjoy reading about tools, rather than just looking at it from an entitled viewpoint of "what can I do to get this running as fast as humanly possible while reading as minimal words as possible". This is a tool that someone else wrote that you get to use for free, so stop whining and let them be free to express themselves as they see fit.
- lionkor 3y agoI'm just not going to use it, yes, i felt like it was only fair to say why
- doubloon 3y agoI think the problem is they named it "Simple", thus implanting in the mind of the reader a certain preconception about what to expect. It is like if you name your project with the words Smart, Open, Trusted, Secure, etc etc, people will tend to point out that it doesn't meet it's name ideal. Contrast with a project like C or BSD. What's the opposite of C? Nothing. Nobody can point out that "Hey, the C language doesn't live up to it's name" because it's name has no connotations or preconceptions.