Hey fellow makers and tinkerers!
You know those moments...
When you're ready to show off your awesome project but final_v3_REAL_actually_final_v2.ino is... somewhere
When that perfectly working CAD file is hiding in one of your 47 "New Folder" directories
When your project is scattered across your desktop, laptop, and that mysterious USB stick labeled "Backup?"
When someone asks about your cool build, but your documentation is spread across three different note-taking apps
When you find an amazing component and you know you have a project for it... but where did you put those files?
Yeah, we've all been there. That's why I built a solution that actually works...
๐ง What I Built
A smart CLI tool that does for your project files what your toolbox does for your workshop - keeps everything organized, accessible, and ready for action. It automatically det
Got project files everywhere? Arduino sketches scattered across your PC? Random STL files you can't find? Fear not, fellow maker! This tool will transform your chaotic project folders into a well-organized maker's paradise!
![Python](https://img.shields.io/badge/Python-3.8%2B-blue)
![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20WSL-lightgrey)
![License](https://img.shields.io/badge/License-MIT-green)
## Made with ๐ ๏ธ by [SKTech] - For Makers, By Makers!
- [Overview & Features](#-perfect-for)
- [Quick Start Guide](#-project-forge-setup-guide)
- [For Beginners](#-wsl-setup-for-beginners-friendly-edition)
- [For WSL Users](#-for-wsl-users)
- [For Linux Users](#-for-linux-pros)
## Basic Usage
- [Project Structure](#-project-structure-youll-get)
- [Using The Tool](#-using-the-project-forge)
- [Common Examples](#-real-world-examples)
- **Smart Project Detection**: Automatically identifies Arduino, PlatformIO projects
- **Code Snippet Organization**: Keep your valuable code bits organized
- **Project Lifecycle**: Track projects from idea to completion
- **Simple Configuration**: Easy to set up and use
- **Windows Friendly**: Works great with WSL!
- After restart, WSL will ask for a username and password
- Remember these credentials!
3. **Get Project Forge Running**
- Press 'Windows + X' and click "Windows Powershell" (not admin)
- Copy and paste these commands one by one:
๐ **Quick Access Tip:** Next time, just open Windows Powershell and run:
'''bash
sudo apt update && sudo apt install python3 python3-pip git && pip3 install PyYAML && git clone https://github.com/Kalougear/ProjectForge.git && cd ProjectForge && python3 -m project_forge
'''
# ๐ For Mac/MacOS Users
### 1. Install Homebrew (if not installed)
'''/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"'''