feat: Enhance project structure and user experience #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Simplified project setup by removing Docker dependencies - Moved Python scripts from resources/ to root directory for easier access - Completely rewrote README.md with comprehensive user-friendly guide: * Added clear step-by-step setup instructions for all platforms * Included detailed explanations of virtual environments and testing * Added troubleshooting section with common issues and solutions * Provided learning goals and success criteria * Enhanced with emojis and better formatting for readability - Removed complex setup scripts (docker_setup.ps1, linux_setup.sh, windows_setup.ps1) - Removed Dockerfile and Docker-related files for simplified setup - Updated .gitignore to exclude virtual environments - Maintained all core lab functionality while improving accessibility This update makes the lab much more accessible to students new to Python development and virtual environments, with clear explanations and step-by-step guidance throughout the process.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎯 Overview
This PR significantly improves the user experience and accessibility of the AAMA-Lab01 project by simplifying setup and providing comprehensive documentation.
📋 Changes Made
Project Structure
resources/to root directory for easier access.gitignoreto exclude virtual environmentsDocumentation Enhancements
Setup Simplification
🎓 Impact
🧪 Testing
Modified by: Md Ubayeid Ullah
Course: CYB4600 - AI in Cybersecurity