Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CLI documentation #113

Merged
merged 4 commits into from
Feb 12, 2024
Merged

Update CLI documentation #113

merged 4 commits into from
Feb 12, 2024

Conversation

aabounegm
Copy link
Collaborator

@aabounegm aabounegm commented Feb 11, 2024

Closes #96.
Just like #112, this should be merged the last to avoid any conflicts.


PR-Codex overview

This PR focuses on improving the documentation and CLI options of the code.

Detailed summary

  • Updated the README.md file to provide clearer instructions on how to use the code.
  • Added information on alternative ways to pass the input expression file.
  • Added information on the output options and how to specify the output file path.
  • Updated the formatting and wording of the README.md file.
  • Updated the formatting of the ruleset file.
  • Updated the formatting and wording of the test cases in the ruleset file.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Base automatically changed from rule-2 to master February 12, 2024 17:38
@aabounegm aabounegm merged commit 633e714 into master Feb 12, 2024
4 checks passed
@aabounegm aabounegm deleted the docs-update branch February 12, 2024 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for output path option
2 participants