Simplify README and restructure documentation

[michaelbrownuc]

Simplifies and restructures the README to focus on individual users running Buttercup locally.

Changes

• Move AKS deployment docs to separate AKS_DEPLOYMENT.md file
• Move manual setup instructions to MANUAL_SETUP.md file
• Create CONTRIBUTING.md with development workflow and contribution guidelines
• Add minimum system requirements (8 CPUs, 64GB RAM, 100GB storage)
• Add supported systems/architectures (Linux x86_64, ARM64 in development)
• Add supported targets (C/Java OSS-Fuzz compatible repositories)
• Add instructions for creating and running challenges
• Add GUI component usage instructions
• Add required system packages info
• Remove alternative manual commands (now automated in Makefile)

Fixes #174

Generated with Claude Code

[ret2libc]

@claude

[claude]

Claude finished @ret2libc's task —— View job

---

I've addressed all the review feedback from @ret2libc systematically.

Completed Changes:

• Update system requirements (reduce RAM requirements from 64GB to 16GB)
• Fix storage requirements (reduce from 100GB to 50GB)
• Remove incorrect build system requirement statement
• Fix ARM support statement to clarify upstream oss-fuzz only
• Update command examples to use make send-libpng-task
• Remove unimplemented GUI features from README
• Remove unimplemented metrics/monitoring references
• Clean up CONTRIBUTING.md based on feedback
• Move challenge creation to separate file or simplify
• Update troubleshooting to reference SigNoz logs
• Commit and push changes

Summary of Changes:

README.md:

• Reduced RAM requirement from 64GB to 16GB (with 10GB basic option noted)
• Reduced storage requirement from 100GB to 50GB
• Clarified ARM64 support is only for upstream Google OSS-Fuzz projects, not AIxCC challenges
• Removed incorrect build system requirement statement
• Updated test command from make send-integration-task to make send-libpng-task
• Removed unimplemented GUI features (Results Dashboard, Log Viewer)
• Simplified challenge creation section to focus on pre-defined challenges
• Added SigNoz reference for log monitoring

CONTRIBUTING.md:

• Updated test command to use make send-libpng-task
• Removed alternative manual commands section
• Removed Docker Development section
• Removed Running Component Tests section as requested
• Added note about cd deployment/docker-compose requirement

All changes have been committed and pushed to the branch.

[michaelbrownuc]

@claude - The main branch of this repository had some merge conflicts that I just resolved, and it may have undone some of your work. Please check over the changes and update the documentation again

[claude]

Claude finished @michaelbrownuc's task —— View job

---

I've checked the documentation files and fixed the issues caused by merge conflicts.

Todo List:

• Analyze current state of documentation files
• Check if previous review feedback was addressed
• Update documentation files as needed
• Commit and push changes

Issues Fixed:

README.md:

• Fixed test command references from make send-integration-task to make send-libpng-task
• Removed "Alternative manual commands" sections as requested in review feedback
• Cleaned up merge conflict artifacts that were causing duplicate content
• Updated challenge description from "Submit the libpng project to the CRS" to "Send a simple challenge to the system"
• Properly structured the "Accessing Logs" section with SigNoz reference

CONTRIBUTING.md:

• Fixed test command reference from make send-integration-task to make send-libpng-task

All changes have been committed and pushed to the branch. The documentation now properly addresses all the review feedback that was previously implemented but got affected by the merge conflict resolution.

View commit

[ret2libc]

Nice job here!! 👍 It reads much better