Skip to content
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

Merged
merged 10 commits into from
Aug 24, 2023
Merged

Rework README file #1374

merged 10 commits into from
Aug 24, 2023

Conversation

rockstorm101
Copy link
Collaborator

Modernize the README file by adding some new sections and deleting out-of-date information. As always, any feedback/criticism is welcome :)

@DivingDuck
Copy link
Collaborator

I like this modernized version very much.

@neofelis2X
Copy link
Contributor

The updated readme is beautiful! A few details that I noticed tho:

Dependencies, line 128:

  • pyglet has to be below 2.0 (1.5.27) due to legacy OpenGL support
  • numpy (for 3D view) - Isn't numpy also used by the STL plater to import stls? Maybe (for Pronterface) should be added instead.

From source, macos, line 212:

  • It is generally not recommended to install python via brew unless one really knows what they are doing. Python via brew can get a bit involved regarding PATH and versions. Especially for beginners it is saver to use the official installers. https://www.python.org/downloads/macos/

@rockstorm101
Copy link
Collaborator Author

Dependencies

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 requirements.txt file? The two lists will likely fall out of sync (has already happened as you rightly pointed out) and it is more tedious to maintain. It'd be great to hear what people think about this.

It is generally not recommended to install python via brew unless one really knows what they are doing. Python via brew can get a bit involved regarding PATH and versions. Especially for beginners it is saver to use the official installers.

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.

@neofelis2X
Copy link
Contributor

Yes, absolutely, having two detailed lists of dependencies would be redundant.
Nice, I have nothing to add to this solution :)

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.
@rockstorm101 rockstorm101 merged commit 3d19237 into kliment:master Aug 24, 2023
21 checks passed
@rockstorm101 rockstorm101 deleted the rework-readme branch August 24, 2023 09:50
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