Slightly Slim Down README #485
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Nice!! |
davvid
approved these changes
Mar 19, 2024
There was a problem hiding this comment.
This looks great! Thanks again.
I believe pip install --editable . should work these days but I haven't tested that on Windows to verify. I do use that on Linux / macOS and things work as expected. The PR is fine as-is, though, since we're removing this section.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR removes and combines some old/outdated parts of the README. For example, it removed the jsonpickleJS section, since the JS version hasn't been updated in 10 years (it's probably very broken right now). It also combines the numpy/pandas sections, since those had a decent bit of duplicated text. Lastly, it removes the section detailing how to install jsonpickle if you have the files locally checked out, since it used a deprecated "setup.py develop" install method, which python warns about on 3.11. This last change might be better with a replacement such as "pip install ." when cd-ed into the directory, but I decided against that because I don't believe that works on Windows.
This is a first step towards getting the README in a readable manner in order to implement #484 in a clean way.