diff --git a/README.md b/README.md index 24319dd..f1d88e5 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ -# ntp-timeturner \ No newline at end of file +# 🕰️ NTP Timeturner + +**NTP Timeturner** is a Raspberry Pi-based stratum 1 time server that sets its system clock based on incoming SMPTE LTC (Linear Timecode) audio. Designed for broadcast and production environments, it allows LTC-based time sync across local networks via NTP. + +--- + +## 📦 Features + +- 🕒 Decodes LTC timecode from audio input (25fps supported) +- 🌐 Serves NTP time to local devices +- ⚡ Fast, reliable startup using a USB audio interface +- 🔌 Optional OLED display for system time and sync status (coming soon) +- 🛜 Web interface for Wi-Fi config and status (in development) + +--- + +## 🚀 Quick Start + +### ✅ Requirements + +- Raspberry Pi 3 or newer +- Debian Bookworm +- USB audio interface with 3.5mm mic/line input +- SMPTE LTC source (e.g. video playout, Blackmagic device) + +### ⚙️ Setup Instructions + +1. Clone the repo: + ```bash + git clone https://github.com/cjfranko/NTP-Timeturner.git + cd NTP-Timeturner diff --git a/setup.sh b/setup.sh index 3dd8d39..d9d19cf 100644 --- a/setup.sh +++ b/setup.sh @@ -1,8 +1,15 @@ #!/bin/bash set -e -echo "🔧 Installing dependencies for NTP Timeturner..." -echo "Hermione, Time to Twist the Timeturner..." +echo "" +echo "─────────────────────────────────────────────" +echo " Welcome to the NTP Timeturner Installer" +echo "─────────────────────────────────────────────" +echo "" +echo "\"It's a very complicated piece of magic...\" – Hermione Granger" +echo "Initialising temporal calibration sequence..." +echo "Requesting clearance from the Ministry of Time Standards..." +echo "" # Update and upgrade packages sudo apt update && sudo apt upgrade -y @@ -16,10 +23,14 @@ sudo apt install -y alsa-utils ffmpeg portaudio19-dev python3-pyaudio # LTC decoding tools sudo apt install -y ltc-tools -# Optional: Network management (if needed later) -# sudo apt install -y network-manager - # Python packages pip3 install numpy -echo "✅ Setup complete. Reboot recommended if this is the first run." +echo "" +echo "─────────────────────────────────────────────" +echo " Setup Complete" +echo "─────────────────────────────────────────────" +echo "" +echo "The TimeTurner is ready. But remember:" +echo "\"You must not be seen.\" – Hermione Granger" +echo ""