-
Notifications
You must be signed in to change notification settings - Fork 999
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rework README file #1374
Rework README file #1374
Conversation
I like this modernized version very much. |
The updated readme is beautiful! A few details that I noticed tho: Dependencies, line 128:
From source, macos, line 212:
|
You are right. I thought about this and forgot. My concern here is: is it really worth keeping a list of dependencies in the README or should we just point to the
Such a claim goes beyond my knowledge so I'm happy with it if you think that's the best for the average novice macOS user. Thank you for pointing that out, this will probably save some headaches to future users. I believe this recommendation goes back to when Python 3 wasn't readily available. So it makes sense that it is no longer relevant any more. I will attempt to address this now but please do not hesitate to send a PR in with updated instructions if you see room for improvement. |
Yes, absolutely, having two detailed lists of dependencies would be redundant. |
Getting "UnicodeDecodeError: 'charmap' codec can't decode byte 0x9d in position 22902: character maps to <undefined>" due to default Windows encoder (cp1252) not being able to decode current README. Need to force UTF-8 encoding.
Modernize the README file by adding some new sections and deleting out-of-date information. As always, any feedback/criticism is welcome :)