diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0afc095 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# ๐Ÿ‘ฅ Contribution Guide + +Welcome to the Hall of Fame! ๐Ÿ† + +Every line of code, every bug fix, every pixel of design โ€” it all comes from people like **you**. + +------------------------------------------------------------------------------------------ +**VisionMate** is more than just an AI project โ€” itโ€™s a growing community of learners, builders, and innovators ๐Ÿ’ก. + +๐Ÿง ๐Ÿ’ป๐ŸŽจ๐Ÿš€๐Ÿ’ฌ +From developers to designers to curious first-timers โ€” we see you, we appreciate you, and we welcome you. + +------------------------------------------------------------------------------------------- + + +## ๐Ÿ› ๏ธ Contribution Areas + +You can contribute to: + +๐ŸŽจPython โ€“ Core backend and computer vision +๐Ÿง OpenCV โ€“ Image processing and recognition +๐Ÿ—ƒ๏ธFlask / Django โ€“ Backend framework (to be finalized) +๐Ÿ“ŠReact.js / Flutter โ€“ Frontend or app interface +๐Ÿ“ŠMySQL โ€“ Data storage +๐Ÿ“‹Google Cloud Vision API โ€“ (future integration) +๐Ÿ“‹Text-to-Speech / Speech-to-Text APIs โ€“ Accessibility tools + + +------------------------------------------------------------------------------------------- + +## ๐Ÿš€ Getting Started + + +Follow these steps to contribute to the VisionMate project on your local machine: + +# 1. Fork the Repository +By clicking on the Fork button of the repository, you get access to commit changes and push them in github. + + +# 2. Clone the repository +git clone https://github.com/kaushav07/VisionMate.git + +# 3. Navigate into the project directory +cd VisionMate + +# 4. Install all the required dependencies +pip install -r requirements.txt + + + + +------------------------------------------------------------------------------------------- + diff --git a/scan_logger.py b/scan_logger.py new file mode 100644 index 0000000..83ec32f --- /dev/null +++ b/scan_logger.py @@ -0,0 +1,37 @@ +import datetime + +# Global list to store scan history +scan_history = [] + +# FUNCTION TO LOG SCAN ENTRY +def log_scan(caption, user_command): + timestamp = datetime.datetime.now().strftime('%d-%m-%Y, %H:%M:%S') + entry = { + "timestamp": timestamp, + "caption": caption, + "user_command": user_command + } + scan_history.append(entry) # โœ… Ensures entry is saved + print("โœ… Logged time and data") + +# FUNCTION TO SHOW ALL HISTORY +def show_history(): + if not scan_history: + print("\n๐Ÿ“ญ No scan history available.") + return + + print("\n๐Ÿ“œ Scan History:") + for i, entry in enumerate(scan_history, start=1): + print(f"\n๐Ÿ”น Entry {i}") + print(f" ๐Ÿ•’ Time: {entry['timestamp']}") + print(f" ๐Ÿ–ผ๏ธ Caption: {entry['caption']}") + print(f" ๐Ÿ’ฌ User Command: {entry['user_command']}") + +# DEMO โ€” RUN ONLY IF FILE IS MAIN +if __name__ == "__main__": + log_scan("A man passing the main road", "Alert User") + log_scan("A family roaming in a busy market", "Describe the surroundings") + log_scan("Animal moving freely in the zoo", "Describe the surroundings") + + show_history() +