Skip to content

Update README Results section with local screenshots instead of external links - #1

Draft
Jay121305 with Copilot wants to merge 2 commits into
mainfrom
copilot/update-readme-results-section
Draft

Update README Results section with local screenshots instead of external links#1
Jay121305 with Copilot wants to merge 2 commits into
mainfrom
copilot/update-readme-results-section

Conversation

Copilot AI commented Oct 7, 2025

Copy link
Copy Markdown

Overview

This PR updates the README's Results section to use locally committed screenshots instead of external GitHub user-attachments URLs. This makes the documentation more reliable and self-contained.

Changes Made

📁 New Directory Structure

  • Created docs/results/ folder to store result screenshots
  • Added four screenshots showcasing the platform's encryption/decryption capabilities:
    • image-encrypted.png - Image encryption result (noise pattern)
    • image-decrypted.png - Image decryption result (recovered image)
    • text-encrypted.png - Text encryption result
    • text-decrypted.png - Text decryption result

📝 README Updates

Before:

![Image Encryption Result](<img width="1889" height="859" alt="Screenshot 2025-10-07 161341" src="https://github.com/user-attachments/assets/ef52f9ed-005a-4dba-aa16-50202f00cee0" />)
*Plain text: "HELLOWORLD" → Encrypted: "WEDRDWGXAD"*

After:

![Encrypted Image Result](docs/results/image-encrypted.png)
*Original image is transformed into encrypted noise pattern*

Improvements:

  • Reliability: Local images won't break if external URLs expire
  • Clean Syntax: Proper markdown image syntax instead of embedded HTML
  • Better Alt Text: More descriptive accessibility text
  • General Captions: Removed specific example values for broader applicability
  • Consistent Ordering: Image examples first, then text examples
  • Dark Theme Context: Captions acknowledge the modern dark-themed UI

Result

The README now showcases the platform's capabilities with reliable, locally-hosted screenshots that properly demonstrate both image and text encryption/decryption features using the GA-optimized hybrid cryptographic techniques.

![README Results Section](https://github.com/user-attachments/assets/189bb01a-9fb8-48cc-aa66-45e88615f6df)
Original prompt

Update the repository README to include the four provided screenshots in the "## 📊 Results" section. The goal is to clearly showcase both image and text encryption/decryption results using locally committed assets (not external user-attachments), with descriptive captions.

Scope of work:

  1. Create a new folder docs/results/ and add the four screenshots there with descriptive filenames:
    • docs/results/text-encrypted.png
    • docs/results/image-decrypted.png
    • docs/results/image-encrypted.png
    • docs/results/text-decrypted.png
  2. Update README.md under the "## 📊 Results" section to:
    • Keep the existing explanation and headings, but replace any external image links with the newly committed local images.
    • Present the results in this order with brief captions:
      a) Image Encryption Example — Encrypted Image (docs/results/image-encrypted.png)
      b) Image Encryption Example — Decrypted Image (docs/results/image-decrypted.png)
      c) Text Encryption Example — Encrypted Text (docs/results/text-encrypted.png)
      d) Text Encryption Example — Decrypted Text (docs/results/text-decrypted.png)
    • Add short one-line captions under each image, similar to the current README style (e.g., “Original image is transformed into encrypted noise pattern”).
  3. Ensure alt text is descriptive (e.g., "Encrypted Image Result", "Decrypted Text Result").
  4. Do not remove other content in README. Only adjust the Results section image links and add the new local asset references.
  5. Validate that the links render correctly on GitHub.

Notes:

  • Preserve the dark-themed UI context in captions.
  • Keep the rest of README as-is.

Relevant images to use (attached below — add them as docs/results/*.png in the repo):
image1
image2
image3
image4

*This pull request was created as a result of the following prompt from Copilot chat.* > Update the repository README to include the four provided screenshots in the "## 📊 Results" section. The goal is to clearly showcase both image and text encryption/decryption results using locally committed assets (not external user-attachments), with descriptive captions. > > Scope of work: > 1) Create a new folder docs/results/ and add the four screenshots there with descriptive filenames: > - docs/results/text-encrypted.png > - docs/results/image-decrypted.png > - docs/results/image-encrypted.png > - docs/results/text-decrypted.png > 2) Update README.md under the "## 📊 Results" section to: > - Keep the existing explanation and headings, but replace any external image links with the newly committed local images. > - Present the results in this order with brief captions: > a) Image Encryption Example — Encrypted Image (docs/results/image-encrypted.png) > b) Image Encryption Example — Decrypted Image (docs/results/image-decrypted.png) > c) Text Encryption Example — Encrypted Text (docs/results/text-encrypted.png) > d) Text Encryption Example — Decrypted Text (docs/results/text-decrypted.png) > - Add short one-line captions under each image, similar to the current README style (e.g., “Original image is transformed into encrypted noise pattern”). > 3) Ensure alt text is descriptive (e.g., "Encrypted Image Result", "Decrypted Text Result"). > 4) Do not remove other content in README. Only adjust the Results section image links and add the new local asset references. > 5) Validate that the links render correctly on GitHub. > > Notes: > - Preserve the dark-themed UI context in captions. > - Keep the rest of README as-is. > > Relevant images to use (attached below — add them as docs/results/*.png in the repo): > ![image1](image1) > ![image2](image2) > ![image3](image3) > ![image4](image4)

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: Jay121305 <210736960+Jay121305@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to include local encryption result screenshots Update README Results section with local screenshots instead of external links Oct 7, 2025
Copilot AI requested a review from Jay121305 October 7, 2025 11:28
@Jay121305

Copy link
Copy Markdown
Owner

@copilot 3️⃣ Output Determinism / Reproducibility

Important for disqualification risk.

Tell me which is true:

A) Same input → same output every time (temperature = 0 / deterministic)

B) Small variation possible, but final classification is stable

C) Outputs may vary noticeably

I will align the report to this.

Copilot AI commented Jan 12, 2026

Copy link
Copy Markdown
Author

@copilot 3️⃣ Output Determinism / Reproducibility

Important for disqualification risk.
...

B) Small variation possible, but final classification is stable

The encryption/decryption algorithms themselves are fully deterministic:

  • Text: Vigenère cipher produces identical output for same key + input
  • Image: XOR + deterministic shuffling (seeded by key sum) produces identical output for same key + input

However, the GA runs at app startup without a fixed seed, generating new keys each session. This means:

  • Within a session: Same input → same output (temperature = 0)
  • Across sessions: Keys vary, so encrypted outputs differ

For reproducible results across sessions, the GA would need a fixed seed (e.g., random.seed(42) before line 21 in genetic_algorithm.py).

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