Skip to content

docs: proofread README and correct usage flags#23

Open
DivInstance wants to merge 1 commit intoPushpenderIndia:masterfrom
DivInstance:docs/readme-proofread-and-usage-fixes
Open

docs: proofread README and correct usage flags#23
DivInstance wants to merge 1 commit intoPushpenderIndia:masterfrom
DivInstance:docs/readme-proofread-and-usage-fixes

Conversation

@DivInstance
Copy link
Copy Markdown

@DivInstance DivInstance commented Oct 6, 2025

This PR improves the documentation for THorse to enhance clarity, accuracy, and usability.

Summary of changes:

  • Corrected terminology (Metasploit, Meterpreter) and fixed common typos (Obfuscate, Roaming, sent, automatically)
  • Fixed Windows usage examples to use the correct -w flag instead of -l
  • Replaced fragile line-number instruction for PYTHON_PYINSTALLER_PATH with a stable variable reference and example
  • Improved grammar and formatting across features, screenshots, and update sections
  • Corrected Linux removal destination path to ~/.config/xinput
  • Normalized step numbering and minor formatting issues

Why:

  • Ensures users can follow instructions without errors
  • Improves GitHub rendering and professionalism
  • Reduces confusion when configuring and running scripts

Testing:

  • Manually reviewed all README sections for rendering and correctness
  • Grepped for remaining obvious typos and incorrect flags

This is a documentation-only change; no code behavior is affected.

Closes #21

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.

Update READme.rd

1 participant