@sriinnu/runic 1.0.0

package/Scripts/INDEX.md

@@ -0,0 +1,365 @@
+# Runic Build Scripts - Complete Index
+
+**Welcome to the Runic build automation system!** This index helps you navigate all scripts and documentation.
+
+## 🚀 Start Here
+
+| Document | Purpose | Read Time |
+|----------|---------|-----------|
+| [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md) | Step-by-step setup guide | 10 min |
+| [QUICK-REFERENCE.md](QUICK-REFERENCE.md) | Quick command lookup | 2 min |
+| [README-SCRIPTS.md](README-SCRIPTS.md) | Complete documentation | 30 min |
+
+**First time?** Start with [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md)
+
+**Need a quick command?** Check [QUICK-REFERENCE.md](QUICK-REFERENCE.md)
+
+**Want details?** Read [README-SCRIPTS.md](README-SCRIPTS.md)
+
+---
+
+## 📁 All Files at a Glance
+
+### Setup Scripts (One-time)
+
+| Script | Purpose | Platforms | Size |
+|--------|---------|-----------|------|
+| **setup-all.sh** ⭐ | Setup everything | All | 9.4K |
+| setup-ios.sh | Setup iOS project | iOS | 11K |
+| setup-react-native.sh | Setup React Native | Android, Windows | 14K |
+
+**Quick Start**: `./scripts/setup-all.sh --verbose`
+
+### Build Scripts (Daily use)
+
+| Script | Purpose | Output | Size |
+|--------|---------|--------|------|
+| build-macos.sh | Build macOS app | builds/macos/Runic.app | 14K |
+| build-ios.sh | Build iOS app | builds/ios/*.ipa | 13K |
+| build-android.sh | Build Android app | builds/android/*.apk | 13K |
+| build-windows.sh | Build Windows app | builds/windows/*.exe | 14K |
+
+**Quick Build**: `./scripts/build-macos.sh`
+
+### CI/CD Configuration
+
+| File | Purpose | Location | Size |
+|------|---------|----------|------|
+| ci-config.yml | GitHub Actions | Copy to .github/workflows/ | 15K |
+
+**Setup CI**: `cp scripts/ci-config.yml .github/workflows/ci.yml`
+
+### Documentation
+
+| Document | Focus | Best For |
+|----------|-------|----------|
+| README-SCRIPTS.md ⭐ | Complete guide | Everything |
+| QUICK-REFERENCE.md | Commands | Daily use |
+| GETTING-STARTED-CHECKLIST.md | Setup steps | First time |
+| CREATION-SUMMARY.md | What was built | Overview |
+| DIRECTORY-STRUCTURE.md | File organization | Navigation |
+| INDEX.md | This file | Finding things |
+
+---
+
+## 🎯 Common Tasks
+
+### First-Time Setup
+1. Read: [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md)
+2. Run: `./scripts/setup-all.sh --verbose`
+3. Configure code signing (see checklist)
+
+### Daily Development
+- macOS: `./scripts/build-macos.sh --skip-tests --skip-signing`
+- iOS: `./scripts/build-ios.sh --simulator --skip-tests`
+- Android: `./scripts/build-android.sh --variant debug`
+- Windows: `./scripts/build-windows.sh --configuration Debug`
+
+### Release Build
+- macOS: `./scripts/build-macos.sh`
+- iOS: `./scripts/build-ios.sh --archive`
+- Android: `./scripts/build-android.sh --aab`
+- Windows: `./scripts/build-windows.sh`
+
+### Troubleshooting
+1. Try: `./scripts/build-macos.sh --dry-run --verbose`
+2. Read: [README-SCRIPTS.md](README-SCRIPTS.md) → Troubleshooting
+3. Check: Script output with `--verbose` flag
+
+### CI/CD Setup
+1. Copy: `cp scripts/ci-config.yml .github/workflows/ci.yml`
+2. Configure: GitHub Secrets (see [README-SCRIPTS.md](README-SCRIPTS.md))
+3. Push: `git push` to trigger workflow
+
+---
+
+## 📚 Documentation by Topic
+
+### Setup & Installation
+- **First-time setup**: [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md) → Prerequisites
+- **macOS setup**: [README-SCRIPTS.md](README-SCRIPTS.md) → macOS Development
+- **iOS setup**: [README-SCRIPTS.md](README-SCRIPTS.md) → iOS Development
+- **Android setup**: [README-SCRIPTS.md](README-SCRIPTS.md) → Android Development
+- **Windows setup**: [README-SCRIPTS.md](README-SCRIPTS.md) → Windows Development
+
+### Building
+- **Quick commands**: [QUICK-REFERENCE.md](QUICK-REFERENCE.md)
+- **macOS builds**: [README-SCRIPTS.md](README-SCRIPTS.md) → build-macos.sh
+- **iOS builds**: [README-SCRIPTS.md](README-SCRIPTS.md) → build-ios.sh
+- **Android builds**: [README-SCRIPTS.md](README-SCRIPTS.md) → build-android.sh
+- **Windows builds**: [README-SCRIPTS.md](README-SCRIPTS.md) → build-windows.sh
+
+### Code Signing
+- **iOS signing**: [README-SCRIPTS.md](README-SCRIPTS.md) → iOS Code Signing
+- **Android signing**: [README-SCRIPTS.md](README-SCRIPTS.md) → Android Code Signing
+- **Quick setup**: [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md) → Code Signing
+
+### CI/CD
+- **GitHub Actions**: [README-SCRIPTS.md](README-SCRIPTS.md) → CI/CD Configuration
+- **Secrets setup**: [README-SCRIPTS.md](README-SCRIPTS.md) → GitHub Secrets
+- **Workflow file**: [ci-config.yml](ci-config.yml)
+
+### Troubleshooting
+- **Common issues**: [README-SCRIPTS.md](README-SCRIPTS.md) → Troubleshooting
+- **macOS issues**: [README-SCRIPTS.md](README-SCRIPTS.md) → macOS Build Issues
+- **iOS issues**: [README-SCRIPTS.md](README-SCRIPTS.md) → iOS Build Issues
+- **Android issues**: [README-SCRIPTS.md](README-SCRIPTS.md) → Android Build Issues
+- **Windows issues**: [README-SCRIPTS.md](README-SCRIPTS.md) → Windows Build Issues
+
+---
+
+## 🔧 Script Features
+
+All scripts include:
+- ✅ `--help` flag for usage information
+- ✅ `--dry-run` flag for safe testing
+- ✅ `--verbose` flag for detailed output
+- ✅ Color-coded output for better UX
+- ✅ Prerequisite checking
+- ✅ Error handling with clear messages
+- ✅ Build summaries
+
+**Example**: `./scripts/build-macos.sh --help`
+
+---
+
+## 🏗️ Project Structure
+
+```
+Runic/
+├── scripts/                    # ← You are here
+│   ├── Setup Scripts
+│   ├── Build Scripts
+│   ├── CI/CD Config
+│   └── Documentation
+│
+├── builds/                     # Build output
+│   ├── macos/
+│   ├── ios/
+│   ├── android/
+│   └── windows/
+│
+├── Sources/                    # Source code
+├── RuniciOS/                   # iOS project
+└── runic-cross-platform/       # React Native
+```
+
+See [DIRECTORY-STRUCTURE.md](DIRECTORY-STRUCTURE.md) for complete structure.
+
+---
+
+## 📊 Statistics
+
+| Metric | Value |
+|--------|-------|
+| Setup Scripts | 3 |
+| Build Scripts | 4 |
+| Documentation Files | 6 |
+| Total New Files | 12 |
+| Lines of Code | ~7,500 |
+| Platforms Supported | 4 |
+| Time Saved | Countless hours! |
+
+---
+
+## 🎓 Learning Path
+
+### Beginner
+1. ✅ Read [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md)
+2. ✅ Run `./scripts/setup-all.sh --dry-run --verbose`
+3. ✅ Run `./scripts/setup-all.sh`
+4. ✅ Try `./scripts/build-macos.sh --help`
+5. ✅ Build your first app: `./scripts/build-macos.sh`
+
+### Intermediate
+1. ✅ Bookmark [QUICK-REFERENCE.md](QUICK-REFERENCE.md)
+2. ✅ Set up code signing for iOS/Android
+3. ✅ Build all platforms
+4. ✅ Customize build flags
+5. ✅ Read platform-specific sections in [README-SCRIPTS.md](README-SCRIPTS.md)
+
+### Advanced
+1. ✅ Set up CI/CD with GitHub Actions
+2. ✅ Configure deployment to TestFlight/Play Store
+3. ✅ Customize scripts for your workflow
+4. ✅ Contribute improvements back to project
+5. ✅ Read full [README-SCRIPTS.md](README-SCRIPTS.md)
+
+---
+
+## ⚡ Quick Reference
+
+### Most Common Commands
+```bash
+# Setup (first time)
+./scripts/setup-all.sh
+
+# Build macOS
+./scripts/build-macos.sh
+
+# Build iOS (simulator)
+./scripts/build-ios.sh --simulator
+
+# Build Android (debug)
+./scripts/build-android.sh --variant debug
+
+# Get help
+./scripts/build-macos.sh --help
+
+# Test without executing
+./scripts/build-macos.sh --dry-run --verbose
+```
+
+### Where to Find Things
+- **Command syntax**: [QUICK-REFERENCE.md](QUICK-REFERENCE.md)
+- **Detailed guide**: [README-SCRIPTS.md](README-SCRIPTS.md)
+- **Setup steps**: [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md)
+- **File locations**: [DIRECTORY-STRUCTURE.md](DIRECTORY-STRUCTURE.md)
+- **What was created**: [CREATION-SUMMARY.md](CREATION-SUMMARY.md)
+
+---
+
+## 🆘 Getting Help
+
+### 1. Built-in Help
+```bash
+./scripts/setup-all.sh --help
+./scripts/build-macos.sh --help
+```
+
+### 2. Dry-Run Mode
+```bash
+./scripts/build-macos.sh --dry-run --verbose
+```
+
+### 3. Check Documentation
+- Quick answers: [QUICK-REFERENCE.md](QUICK-REFERENCE.md)
+- Detailed help: [README-SCRIPTS.md](README-SCRIPTS.md)
+- Setup issues: [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md)
+
+### 4. Troubleshooting Section
+See [README-SCRIPTS.md](README-SCRIPTS.md) → Troubleshooting
+
+### 5. Verbose Output
+```bash
+./scripts/build-macos.sh --verbose
+```
+
+---
+
+## ✨ Pro Tips
+
+1. **Always try `--dry-run` first** to see what a script will do
+2. **Use `--verbose`** when debugging issues
+3. **Read error messages carefully** - they include solutions
+4. **Bookmark QUICK-REFERENCE.md** for daily use
+5. **Keep README-SCRIPTS.md open** when troubleshooting
+6. **Use `--help`** to discover all options
+7. **Start simple** - build one platform at a time
+8. **Configure CI/CD early** - catch issues faster
+
+---
+
+## 🎯 Success Checklist
+
+You know you're set up correctly when:
+- ✅ `./scripts/setup-all.sh` completes without errors
+- ✅ `./scripts/build-macos.sh` produces `builds/macos/Runic.app`
+- ✅ `./scripts/build-ios.sh --simulator` runs successfully
+- ✅ `./scripts/build-android.sh --variant debug` creates APK
+- ✅ CI/CD workflow passes on GitHub
+- ✅ You can build all platforms locally
+
+---
+
+## 📖 Full Documentation Map
+
+```
+scripts/
+├── INDEX.md ⭐                        # This file - Start here
+│
+├── GETTING-STARTED-CHECKLIST.md      # Step-by-step setup
+│   ├── Prerequisites
+│   ├── First-time setup
+│   ├── Code signing
+│   ├── First builds
+│   ├── CI/CD setup
+│   └── Daily workflow
+│
+├── QUICK-REFERENCE.md                # Quick command lookup
+│   ├── One-line commands
+│   ├── Common flags
+│   ├── Build outputs
+│   └── Troubleshooting
+│
+├── README-SCRIPTS.md                 # Complete documentation
+│   ├── Overview
+│   ├── Quick Start
+│   ├── Setup Scripts (detailed)
+│   ├── Build Scripts (detailed)
+│   ├── CI/CD Configuration
+│   ├── Platform-Specific Guides
+│   ├── GitHub Secrets
+│   ├── Troubleshooting
+│   └── Advanced Usage
+│
+├── CREATION-SUMMARY.md               # What was created
+│   ├── File list
+│   ├── Features
+│   ├── Statistics
+│   └── Usage examples
+│
+└── DIRECTORY-STRUCTURE.md            # File organization
+    ├── Directory tree
+    ├── Execution flow
+    ├── Artifact structure
+    └── Navigation guide
+```
+
+---
+
+## 🚀 Ready to Build?
+
+**Quickest start:**
+```bash
+# 1. Setup
+./scripts/setup-all.sh
+
+# 2. Build
+./scripts/build-macos.sh
+
+# 3. Run
+open builds/macos/Runic.app
+```
+
+**Need help?** Check [GETTING-STARTED-CHECKLIST.md](GETTING-STARTED-CHECKLIST.md)
+
+**Already set up?** See [QUICK-REFERENCE.md](QUICK-REFERENCE.md)
+
+**Want to learn more?** Read [README-SCRIPTS.md](README-SCRIPTS.md)
+
+---
+
+**Happy Building! 🎉**
+
+For questions, issues, or contributions, see the main Runic repository.

package/Scripts/QUICK-REFERENCE.md

@@ -0,0 +1,164 @@
+# Runic Build Scripts - Quick Reference Card
+
+## One-Line Commands
+
+### Setup (First Time)
+
+```bash
+# Setup everything
+./scripts/setup-all.sh
+
+# Setup specific platform
+./scripts/setup-all.sh --only-ios
+./scripts/setup-all.sh --only-rn
+```
+
+### Build (Development)
+
+```bash
+# macOS
+./scripts/build-macos.sh --configuration debug --skip-signing
+
+# iOS (Simulator)
+./scripts/build-ios.sh --simulator --configuration Debug
+
+# Android (Debug)
+./scripts/build-android.sh --variant debug
+
+# Windows (Debug)
+./scripts/build-windows.sh --configuration Debug
+```
+
+### Build (Release)
+
+```bash
+# macOS
+./scripts/build-macos.sh
+
+# iOS (Archive for TestFlight)
+./scripts/build-ios.sh --archive
+
+# Android (AAB for Play Store)
+./scripts/build-android.sh --aab
+
+# Windows
+./scripts/build-windows.sh
+```
+
+## Common Flags
+
+| Flag | Description |
+|------|-------------|
+| `--dry-run` | Show what would happen (safe) |
+| `--verbose` | Detailed output for debugging |
+| `--skip-tests` | Skip running tests |
+| `--clean` | Clean before building |
+| `--help` | Show help message |
+
+## Build Outputs
+
+| Platform | Location |
+|----------|----------|
+| macOS | `builds/macos/Runic.app` |
+| iOS | `builds/ios/` |
+| Android | `builds/android/app-*.apk` |
+| Windows | `builds/windows/` |
+
+## Troubleshooting One-Liners
+
+```bash
+# Check prerequisites
+./scripts/setup-all.sh --dry-run --verbose
+
+# Test build without executing
+./scripts/build-macos.sh --dry-run
+
+# Clean build
+./scripts/build-android.sh --clean --verbose
+
+# Debug specific platform
+./scripts/build-ios.sh --verbose --simulator
+```
+
+## CI/CD Setup
+
+```bash
+# 1. Copy workflow
+mkdir -p .github/workflows
+cp scripts/ci-config.yml .github/workflows/ci.yml
+
+# 2. Configure secrets in GitHub
+# (See README-SCRIPTS.md for complete list)
+
+# 3. Push and watch it build
+git add .github/workflows/ci.yml
+git commit -m "Add CI/CD"
+git push
+```
+
+## Code Signing Quick Start
+
+### iOS
+```bash
+# 1. Open Xcode
+open RuniciOS/*.xcodeproj
+
+# 2. Select target > Signing & Capabilities
+# 3. Choose team and enable automatic signing
+```
+
+### Android
+```bash
+# 1. Generate keystore
+keytool -genkey -v -keystore release.keystore -alias runic -keyalg RSA -keysize 2048 -validity 10000
+
+# 2. Create keystore.properties
+cat > runic-cross-platform/android/keystore.properties << 'EOF'
+storePassword=YOUR_PASSWORD
+keyPassword=YOUR_PASSWORD
+keyAlias=runic
+storeFile=release.keystore
+EOF
+
+# 3. Build signed APK
+./scripts/build-android.sh --variant release
+```
+
+## Most Common Commands
+
+```bash
+# Daily development workflow
+./scripts/build-macos.sh --skip-tests --skip-signing
+./scripts/build-ios.sh --simulator --skip-tests --configuration Debug
+
+# Release workflow
+./scripts/build-macos.sh
+./scripts/build-ios.sh --archive
+./scripts/build-android.sh --aab
+
+# Debug build issues
+./scripts/build-macos.sh --verbose --dry-run
+./scripts/build-android.sh --clean --verbose
+```
+
+## Help & Documentation
+
+```bash
+# Quick help for any script
+./scripts/setup-all.sh --help
+./scripts/build-macos.sh --help
+
+# Full documentation
+cat scripts/README-SCRIPTS.md
+
+# Creation summary
+cat scripts/CREATION-SUMMARY.md
+```
+
+---
+
+**Tip**: Start with `--dry-run --verbose` to see what a script will do before running it!
+
+**Tip**: Use `--help` on any script to see all available options!
+
+**Tip**: See `README-SCRIPTS.md` for comprehensive documentation and troubleshooting!