Update README #123
Merged
Update README #123
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
Jaclynpqc
requested review from
tuduun,
AidanNeeson,
laurennevill,
jnormile,
bergasanargya,
AlishChhetri and
boulais01
|
This looks great, but I also have a few additions/ changes to the readme on a file I have not PRed yet. Would I be able to wrap that up and jump onto this PR, or should I just make another? I will have my edits in for review by the lab. |
|
@AlishChhetri is your change about creating the Wiki? |
|
@Jaclynpqc Its about adding a section dedicated to testing and additional details about setting up the developer environment. Most of the content will have a focus on providing more details for future developers of the tool. |
boulais01
previously approved these changes
Dec 5, 2023
|
If its okay with @Jaclynpqc, lets have @AlishChhetri jump on and add his README changes so that we can get all changes pushed at once! |
laurennevill
requested changes
Dec 8, 2023
laurennevill
previously approved these changes
Dec 8, 2023
boulais01
dismissed stale reviews from AlishChhetri and laurennevill
via
8014841
laurennevill
approved these changes
Dec 8, 2023
boulais01
approved these changes
Dec 8, 2023
AlishChhetri
approved these changes
Dec 8, 2023
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.
The purpose of this pull request is to enhance the README file by organizing sections, providing a detailed comparison between Chasten and Symbex, suggesting similar tools, and offering a quick reference for Chasten command options. These changes aim to improve user understanding, facilitate tool selection, and enhance overall documentation.
Changes Made:
Section Organization: Organized sections in the README file for better clarity and readability.
Chasten vs. Symbex Comparison Section: Added a new section titled
🤓 Chasten vs. Symbexto provide a detailed comparison between Chasten and Symbex. This section covers their command-line interfaces (CLI) and functionality, helping users make informed decisions based on their preferences and requirements.Similar Tools Section: Introduced a section titled
📦 Similar Toolsthat highlights alternative tools for code analysis. Included brief descriptions of two tools: pyastgrep by Luke Plant and treesitter.chasten--help Section: Added a new section titled
✨chasten--helpto showcase the available options when using the chasten command. This provides users with quick reference information on how to interact with Chasten through the command line.