pyPhotoAlbum/GET_STARTED.md
Duncan Tourolle a7558e3c39
All checks were successful
Python CI / test (push) Successful in 1m11s
Lint / lint (push) Successful in 1m9s
Tests / test (3.10) (push) Successful in 55s
Tests / test (3.11) (push) Successful in 56s
Tests / test (3.9) (push) Successful in 53s
updated tests and installer
2025-11-11 13:21:35 +01:00

96 lines
2.1 KiB
Markdown

# 🚀 Get Started with pyPhotoAlbum
## Quick Installation (Recommended)
```bash
# Generate icons and install everything
./generate_icons.sh && ./install.sh
# Launch the app
pyphotoalbum
```
After installation, log out and back in to refresh GNOME. You can then launch from the terminal or by searching "photo" in Activities.
---
## Alternative Installation Methods
### 📦 Fedora RPM Package
```bash
# Create source tarball
cd ..
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/ --exclude=.git --exclude=venv --exclude=__pycache__
mv pyphotoalbum-0.1.0.tar.gz ~/rpmbuild/SOURCES/
cd pyPhotoAlbum
# Build and install
rpmbuild -ba pyphotoalbum.spec
sudo dnf install ~/rpmbuild/RPMS/noarch/pyphotoalbum-0.1.0-1.*.noarch.rpm
```
### 📦 Arch/CachyOS Package
```bash
# Create source tarball
cd ..
tar czf pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/ --exclude=.git --exclude=venv --exclude=__pycache__
mv pyphotoalbum-0.1.0.tar.gz pyPhotoAlbum/
cd pyPhotoAlbum
# Build and install
makepkg -si
```
### 💻 Development Installation
```bash
# Create virtual environment
python -m venv venv
source venv/bin/activate
# Install in editable mode with dev tools
pip install -e ".[dev]"
# Run the app
python pyPhotoAlbum/main.py
```
---
## 🎯 Features After Installation
**Command:** `pyphotoalbum` available in terminal
**Icon:** Beautiful camera icon in GNOME Activities
**Taskbar:** Proper icon when app is running
**Menu:** Right-click for "New Project" action
**Search:** Find by typing "photo" in Activities
**Grouping:** Multiple windows group under one icon
---
## 🆘 Troubleshooting
### Command not found?
```bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
```
### Icon not showing?
```bash
./generate_icons.sh
./install.sh
rm -f ~/.cache/icon-cache.kcache
```
Then log out and back in.
### Need detailed help?
See [INSTALLATION.md](INSTALLATION.md) for comprehensive installation instructions and troubleshooting.
---
**Estimated time:** 5-10 minutes
**Questions?** Open an issue or check [INSTALLATION.md](INSTALLATION.md)