Initial push

1 files changed, 67 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef1a0bb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+# MAX25-Stack-Lite · 1.8.0
+
+Minimal and fully functional for **terminal(s)** and **packet radio**.
+
+For **localhost** installation on the **terminal computer only** — modem, daemon, and terminal on the **same machine**. No LAN bridges, no remote terminal.
+
+**Platforms:** **POSIX-like only** — \*Linux · \*BSD · macOS · **Windows → WSL required** · Windows-native build later roadmap
+
+---
+
+## Quick start (max25-terminal path)
+
+**Debian / Ubuntu / Mint:**
+
+```bash
+sudo apt update
+sudo apt install -y git cmake build-essential libncurses-dev whiptail alsa-utils
+sudo usermod -aG dialout "$USER"    # log out and back in
+git clone https://github.com/ngteq/MAX25-Stack-Lite.git
+cd MAX25-Stack-Lite
+cmake -B build && cmake --build build
+./scripts/max25-lite-setup.sh
+./scripts/run-max25d.sh
+./scripts/run-max25-terminal.sh -U /run/max25/modem.sock
+```
+
+At the `>` prompt: **CONNECT QST** · **RX before TX** (prove receive before transmit).
+
+---
+
+## Build tools by platform
+
+| Platform | Install (typical) |
+|----------|-------------------|
+| **Debian / Ubuntu / Mint** | `sudo apt install git cmake build-essential libncurses-dev whiptail alsa-utils` |
+| **Fedora / CentOS Stream / RHEL** | `sudo dnf install git cmake gcc gcc-c++ make ncurses-devel newt alsa-utils` |
+| **openSUSE / SUSE** | `sudo zypper install git cmake gcc gcc-c++ make ncurses-devel libncurses6 whiptail alsa-utils` |
+| **Arch Linux** | `sudo pacman -S git cmake base-devel ncurses alsa-utils`; wizard: `dialog` or `whiptail` from AUR |
+| **Gentoo** | `emerge -av dev-vcs/git dev-util/cmake sys-libs/ncurses net-misc/alsa-utils`; wizard: `app-admin/dialog` |
+| **FreeBSD** | `pkg install git cmake gmake ncurses python3 dialog` (audio: native OSS, no extra package) |
+| **macOS** | Xcode CLI + Homebrew: `brew install cmake ncurses python3 dialog`; build from source tree (manual INI until wizard port) |
+| **Windows** | **Use WSL** (Ubuntu/Debian recommended) — follow the **Debian / Ubuntu / Mint** row inside WSL; native Windows build **deferred** (late roadmap, not v1) |
+
+After install: join the serial group on Linux or WSL (`dialout`) and **log out and back in**.
+
+---
+
+## Verify (error-free)
+
+```bash
+cmake --build build --target max25_daemon_smoke
+```
+
+---
+
+## Scope
+
+| In | Out |
+|----|-----|
+| max25-terminal, max25-client | Remote / LAN terminal |
+| max25d + setup wizard (localhost) | HyBBX, web UI |
+| **BayCom/based** (`max25-bcpr`, device **max25e0**) | Multi-RF co-host |
+| CRDOP soft modem | Network bridges |
+| USB KISS without max25d (parallel) | |
+
+---
+