Refactor/12392 v1 Edited README and ISSUES for pre-release, removed unused shell scripts

[KEIAHNY]

PR Type

Documentation, Other

---

Description

• Remove unused Suricata testing shell scripts

• Update README for v1.0.0-dev pre-release

  • Add System and Suricata configuration prerequisites
  • Document memcap and single-interface limitations

• Add memory reallocation item to ISSUES.md

---

Diagram Walkthrough

flowchart LR
  pr["PR changes"] -- "delete" --> scripts["Unused shell scripts"]
  pr -- "update" --> readme["README v1.0.0-dev docs"]
  pr -- "extend" --> issues["ISSUES.md future work"]

Loading

File Walkthrough

	Relevant files
Miscellaneous	configs.sh Delete unused Suricata config generation script                    src/configs.sh Deleted entire script that generated Suricata configuration test runs Removed NIC setup and TRex traffic generation loop logic +0/-34    runs.sh Delete unused Suricata test runner script                                src/runs.sh Deleted entire script that tested generated Suricata configurations Removed Suricata execution, log collection, and results aggregation logic +0/-56
Documentation	ISSUES.md Add memcap reallocation future work item                                  ISSUES.md Added future work item for memory reallocation when memcap limit is reached +1/-0      README.md Update README prerequisites and warnings for v1.0.0-dev    README.md Updated version references from v1.0-dev to v1.0.0-dev Added System section requiring NUMA-bound network interface Added Suricata configuration file section with memcap warning Added warning that cpu_affinity module supports only a single interface +20/-3

---

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Typo Line 7 contains a double space between Suriconf and v1.0.0-dev ("Suriconf v1.0.0-dev"). This was introduced in this PR while editing the sentence, and renders as an unintended extra space in the README. Suriconf is an automated configuration assistant for [Suricata](https://github.com/OISF/suricata). It analyzes network traffic and system resources to optimize Suricata's configuration through a modular approach. Each module uses mathematical methods and performance metrics to configure specific Suricata components. Testing showed Suriconf v1.0.0-dev successfully configured Suricata in 80.8% of test cases with [rules](https://community.emergingthreats.net/). Inconsistent character Line 46 uses a non-ASCII hyphen character in v1.0.0‑dev (U+2011 non-breaking hyphen) instead of the regular ASCII hyphen used elsewhere in the document (v1.0.0-dev). This can cause inconsistent rendering and makes the version string not match search/copy-paste of the standard form. Suriconf v1.0.0‑dev requires the network interface to be bound to a specific NUMA node.

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[KEIAHNY]

Closing – applying recommendations