Overhaul README.md #56
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
perennialtech
force-pushed
the
update-documentation
branch
from
dadf26e
to
c399ea7
Compare
|
Thanks for this! Merging! |
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 introduces several changes to the project README aimed at improving readability. Key changes include:
Reorganised content: Several sections have been moved and restructured for better logical flow. For example, deployment instructions previously found under 'Installation' as a subsection have been consolidated into a separate 'Deployment' section.
Added table of contents:: A ToC has been added for easier navigation.
Added GitHub Flavored Markdown admonitions: GFM callouts such as
> [!NOTE]and> [!IMPORTANT]are now used highlight tips and critical information, ensuring they stand out.Added comparison to Libreddit: A section under 'How is it different from other Reddit front ends?' has been added comparing Redlib and Libreddit (closes issue #32).
Miscellaneous updates: Languages have been added to code blocks for syntax highlighting and hyperlinks to some external resources have been included. Additionally, minor updates to the raw formatting of the document have also been made.
Changes have been made in many smaller commits, but can be squashed into a larger commit if needed.