Skip to content

Add README#24

Merged
pilsnerfrajz merged 19 commits into
mainfrom
readme
Sep 13, 2025
Merged

Add README#24
pilsnerfrajz merged 19 commits into
mainfrom
readme

Conversation

@pilsnerfrajz
Copy link
Copy Markdown
Owner

@pilsnerfrajz pilsnerfrajz commented Sep 13, 2025

Add README

Add a README file to the repo to explain how the program works for other users.

Sections

  • Badges and description
  • Table of contents
  • Installation and Dependencies
    • Add steps for cloning and building the repo, along with installation steps for libpcap for Linux and Mac
  • Usage
    • Usage and example commands
  • Testing
    • Testing instructions and the test coverage
  • Technical details
    • Description of ARP and its implementation
    • Description of Ping and its implementation
    • Description of TCP SYN and its implementation

@pilsnerfrajz pilsnerfrajz added the documentation Improvements or additions to documentation label Sep 13, 2025
@pilsnerfrajz pilsnerfrajz merged commit 046e03f into main Sep 13, 2025
2 checks passed
@pilsnerfrajz pilsnerfrajz deleted the readme branch September 13, 2025 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant