Improving project documentation ⚡ #64
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
Rephrase several words and update the documentation about this project
Rephrase several words and update the documentation about this project
This changes includes:
* Moved and changed the 'Table of Contents'
* Created a new header named `Installation` and improved its description
* Improved readability on the example matrix by changing its matrix display
with LaTex instead built-in Markdown code display
* Added 'About JMatrix' section * Updated the 'Table of Contents'
* Added the description for each matrix operation * Enhanced the code examples
Merged
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.
What's Changed
Updated the
README.mdwith more detailed information about the project, including installation instructions, prerequisites, and usage.Fixed and updated various links in the
README.mdfile to ensure they point to the correct locations.Updated the 'Matrix Operations' section with detailed examples of matrix operations, including addition, subtraction, scalar multiplication, matrix multiplication, and transposition.
Improved the 'Constructor Summary' section by providing detailed descriptions and examples for each constructor.
Updated the 'Author' and 'License' sections to provide more accurate information.
Improve grammars and clarity.
All Commits
README.mdREADME.mdREADME.mdREADME.mdREADME.mdREADME.mdSummary
These changes are intended to make it easier for users to understand and use the JMatrix library. The documentation now provides clear instructions on installation, prerequisites, and usage, along with detailed examples of matrix operations and constructor usage.