made some changes to README and docs#49
Merged
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Links: Fix broken links in README and pyproject.toml:
Link to documentation website (GitHub Pages) in README and pyproject.toml.
Fix "Build Status" link.
Fix broken internal links to find_duplicates and visualize_dir in docs.
Function List: Add a brief list of user-facing functions to the README.
Motivation: Add a section explaining why to use this package over standard tools (mv, find).
Comparisons: Add a section comparing/relating to other similar packages.
Installation: Clarify installation instructions (cloning vs PyPI/TestPyPI) for inexperienced users. Add PyPI install instructions.
Examples: Simplify examples in documentation (especially largest_files) and add simple examples to the README.