Closed Jaclynpqc closed 7 months ago
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.
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!
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. Symbex
to 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 Tools
that 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--help
to 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.