Readme.md clean up: reorganize and remove repetition#256
Open
lb803 wants to merge 10 commits into
Open
Conversation
Moved the license section to the bottom of `README.md` (common convention). Rephrased for clarity and added a link to the `LICENSE` file.
Split the feedback and contribution sections for clarity and moved the latter further down the document, as it seems a more conventional location.
Commented out non-working badges to reduce clutter in the README.
Consolidated repeated links (website, wiki, blog) at the top of the README and removed duplicates.
Updated the document title to use "offlineimap3" (instead of "offlineimap") to match the repository name and avoid confusion.
Updated the "Project Status and Future" section to explicitly refer to the project as **OfflineIMAP3** and clarified the Python 3 port details.
Clarified the installation process by splitting it into two distinct options: installing from a tarball/zipball or using a package manager. Improved readability and structure.
Moved the fedback section to the bottom of `README.md` (seems better place for it).
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
1 participant
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
References
Additional information
Reorganized the README for better clarity and flow, while preserving all content. Removed repetitions and improved structure.