Installation Guide.md - himent12/FlashGenie GitHub Wiki
📥 Installation Guide
This guide provides step-by-step instructions for installing FlashGenie v1.5 on your system.
📋 System Requirements
Before installing FlashGenie, ensure your system meets these requirements:
- Python 3.8 or higher
- 50MB free disk space
- Terminal/Command prompt access
- Git (optional but recommended)
🔧 Installation Methods
Method 1: Git Clone (Recommended)
=== "Windows"
```cmd
# Open Command Prompt or PowerShell
git clone https://github.com/himent12/FlashGenie.git
cd FlashGenie
pip install -r requirements.txt
```
=== "macOS"
```bash
# Open Terminal
git clone https://github.com/himent12/FlashGenie.git
cd FlashGenie
pip3 install -r requirements.txt
```
=== "Linux"
```bash
# Open Terminal
git clone https://github.com/himent12/FlashGenie.git
cd FlashGenie
pip3 install -r requirements.txt
```
Method 2: Download ZIP
- Go to FlashGenie GitHub
- Click "Code" → "Download ZIP"
- Extract the ZIP file
- Open terminal in the extracted folder
- Run:
pip install -r requirements.txt
Method 3: PyPI (Coming Soon)
# Install from PyPI
pip install flashgenie
# Or install in development mode
pip install -e .
✅ Verify Installation
Test that FlashGenie is working:
python -m flashgenie --version
You should see: FlashGenie v1.8.2
🔄 Updating FlashGenie
Keep FlashGenie up to date with the latest features:
# If installed via Git
cd FlashGenie
git pull
pip install -r requirements.txt
# If installed via PyPI (coming soon)
pip install --upgrade flashgenie
🛠️ Troubleshooting
Common Installation Issues
Issue | Solution |
---|---|
Python version too old | Update Python to 3.8+ from python.org |
Permission errors | Use sudo pip install (Linux/Mac) or run as Administrator (Windows) |
Package conflicts | Create a virtual environment: python -m venv venv |
Git not found | Install Git from git-scm.com |
Getting Help
If you encounter issues not covered here:
- Check the Troubleshooting guide
- Visit GitHub Issues
- Join our community discussions
🎉 Next Steps
Now that you've installed FlashGenie, you're ready to start learning!
- Quick Start Tutorial - Your first 10 minutes with FlashGenie
- Basic Commands - Essential CLI commands to get you started
- Creating Your First Deck - Build your first flashcard collection
FlashGenie v1.8.2 | Last updated: June 2025