Skip to content

Refresh README visuals with real obfuscation terminal GIF and Medium preset output excerpt#219

Merged
levno-710 merged 4 commits intomasterfrom
copilot/improve-readme-visuals
Mar 24, 2026
Merged

Refresh README visuals with real obfuscation terminal GIF and Medium preset output excerpt#219
levno-710 merged 4 commits intomasterfrom
copilot/improve-readme-visuals

Conversation

Copy link
Contributor

Copilot AI commented Mar 24, 2026

Improves the main README’s presentation while preserving existing content and structure. Adds a clearer visual entry point for new users by showing a real obfuscation run and a real output excerpt.

  • README visual refresh

    • Added a new ## Preview section to the main README.
    • Embedded an animated asset: assets/readme/obfuscation-preview.gif.
    • Kept existing sections/content intact and in the same general order.
  • Preview GIF updated to real CLI output

    • Regenerated assets/readme/obfuscation-preview.gif from an actual cli.lua obfuscation run.
    • The GIF now shows real terminal output during obfuscation, including colorized log styling.
  • Obfuscation output preview

    • Replaced the handcrafted/simplified output sample with an excerpt from a real obfuscated file generated using the Medium preset.
    • Clarified in the README that the shown block is an excerpt and intentionally truncated.
-- input.lua
local secret = "Prometheus"
local answer = 42
print(secret .. " -> " .. answer)

-- generated with: lua ./cli.lua --preset Medium ./simple.lua
-- excerpt from ./simple.obfuscated.lua
return(function(...)local L={"afT6mf1V","/7mJXsuvmE1c/fT3"; ...}
... (remaining obfuscated output omitted)
  • Copy polish

    • Minor wording/capitalization cleanup in existing README text (no semantic/content expansion).
  • Assets

    • Updated assets/readme/obfuscation-preview.gif for in-README rendering.
https://github.com/user-attachments/assets/6e3e5d13-c789-4336-8dab-b346c3963449
Original prompt

Create a new branch. In this branch, improve the main Readme. Mainly focus on improving looks (Render nice preview of obfuscated code, gif of obfuscation process, etc.). Content should mostly stay the same, but you may improve wording.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Copilot AI changed the title [WIP] Update main Readme to enhance visuals and readability Refresh README visuals with obfuscation preview GIF and before/after code sample Mar 24, 2026
Copilot AI requested a review from levno-710 March 24, 2026 22:38
@levno-710
Copy link
Member

Please make the gif show the actual terminal output while obfuscating a simple script. For the preview, please obfuscate a script using medium preset and show a part of that script

Copy link
Contributor Author

Copilot AI commented Mar 24, 2026

Please make the gif show the actual terminal output while obfuscating a simple script. For the preview, please obfuscate a script using medium preset and show a part of that script

Done in commit 6800f06. The GIF now shows real terminal output from an actual lua ./cli.lua --preset Medium run on a simple script, and the README output preview now contains an excerpt from that real generated obfuscated file. Screenshot: https://github.com/user-attachments/assets/6e3e5d13-c789-4336-8dab-b346c3963449

Copilot AI changed the title Refresh README visuals with obfuscation preview GIF and before/after code sample Refresh README visuals with real obfuscation terminal GIF and Medium preset output excerpt Mar 24, 2026
Copilot AI requested a review from levno-710 March 24, 2026 22:50
@levno-710 levno-710 marked this pull request as ready for review March 24, 2026 22:54
@levno-710 levno-710 merged commit a78880a into master Mar 24, 2026
2 checks passed
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.

2 participants