diff --git a/README.md b/README.md index 136926854..9d309a424 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ "The Tet. What a brilliant machine" — Morgan Freeman as he reminisces about alien superintelligence in the movie Oblivion

+> **Early Beta** — Under active development. Expect rough edges. + OpenHuman is an open-source agentic assistant that is designed to integrate with you in your daily life. Here's what makes OpenHuman special: - **One subscription, many providers** — One assistant wired to **skills** and backend models so you are not juggling a separate subscription stack for every integration surface. @@ -47,16 +49,17 @@ Architecture: [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md). Contributor orient > **Early Beta** — Under active development. Expect rough edges. -| Platform | Variant | Download | -| ----------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ | -| **macOS** | Apple Silicon (M1/M2/M3/M4) | [`.dmg` (aarch64)](https://github.com/tinyhumansai/openhuman/releases/latest/download/OpenHuman_aarch64.dmg) | -| **macOS** | Intel | [`.dmg` (x64)](https://github.com/tinyhumansai/openhuman/releases/latest/download/OpenHuman_x64.dmg) | -| **Windows** | x64 | [`.msi`](https://github.com/tinyhumansai/openhuman/releases/latest/download/OpenHuman_x64_en-US.msi) | -| **Linux** | Debian / Ubuntu | [`.deb` (amd64)](https://github.com/tinyhumansai/openhuman/releases/latest/download/OpenHuman_amd64.deb) | -| **Linux** | Fedora / RHEL | [`.rpm` (x86_64)](https://github.com/tinyhumansai/openhuman/releases/latest/download/OpenHuman_x86_64.rpm) | -| **Linux** | Universal | [`.AppImage`](https://github.com/tinyhumansai/openhuman/releases/latest/download/OpenHuman_amd64.AppImage) | +You can download the latest desktop build from the website at [tinyhuman.ai/openhuman](https://tinyhuman.ai/openhuman). You can also grab it from the [latest GitHub release](https://github.com/tinyhumansai/openhuman/releases/latest), which includes all current artifacts (`.dmg`, `.deb`, `.AppImage`, `.app.tar.gz`, and more). -Browse all releases: [github.com/tinyhumansai/openhuman/releases](https://github.com/tinyhumansai/openhuman/releases) +If you need an older version, browse [all releases](https://github.com/tinyhumansai/openhuman/releases). + +If you want to build from source, see [`docs/BUILDING.md`](docs/BUILDING.md). + +Or you can basically run this global install script + +``` +COMING SOON curl -fsSL https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.sh | bash +``` # Under the hood (Architecture) diff --git a/docs/BUILDING.md b/docs/BUILDING.md new file mode 100644 index 000000000..69b204d0e --- /dev/null +++ b/docs/BUILDING.md @@ -0,0 +1,96 @@ +# Building & Installing OpenHuman + +This guide covers two paths: + +1. Build and compile OpenHuman from source +2. Install the latest stable release binaries + +## Prerequisites + +- `git` +- `node` + `yarn` +- Rust toolchain (see `rust-toolchain.toml`) + +## Build from source (local compile) + +Run from the repository root: + +```bash +# 1) Clone and enter the repo +git clone https://github.com/tinyhumansai/openhuman.git +cd openhuman + +# 2) Install JS deps (workspace) +yarn install + +# 3) Build Rust core binary +cargo build --manifest-path Cargo.toml --bin openhuman + +# 4) Stage core sidecar for the desktop app +cd app +yarn core:stage + +# 5) Build desktop app artifacts +yarn build +``` + +For local development instead of production build: + +```bash +yarn dev +``` + +## Install latest stable release (macOS/Linux) + +Use this basic script to detect platform/arch and download the latest stable artifact from GitHub Releases: + +```bash +#!/usr/bin/env bash +set -euo pipefail + +REPO="tinyhumansai/openhuman" +BASE="https://github.com/${REPO}/releases/latest/download" +OS="$(uname -s)" +ARCH="$(uname -m)" + +if [[ "$OS" == "Darwin" ]]; then + if [[ "$ARCH" == "arm64" ]]; then + FILE="OpenHuman_0.49.32_aarch64.dmg" + else + FILE="OpenHuman_0.49.32_x64.dmg" + fi +elif [[ "$OS" == "Linux" ]]; then + # Prefer AppImage for broad compatibility. + FILE="OpenHuman_0.49.32_amd64.AppImage" +else + echo "Unsupported OS: $OS" + exit 1 +fi + +URL="${BASE}/${FILE}" +echo "Downloading: $URL" +curl -fL "$URL" -o "$FILE" + +echo "Downloaded $FILE" +echo "Install it with your platform's normal installer flow." +``` + +Notes: + +- The filename includes the release version and should be updated when a new stable release is cut. +- You can always manually download from: + - Website: https://tinyhuman.ai/openhuman + - Latest release: https://github.com/tinyhumansai/openhuman/releases/latest + +## Windows (latest stable) + +Download directly from the website or latest release page: + +- https://tinyhuman.ai/openhuman +- https://github.com/tinyhumansai/openhuman/releases/latest + +## Future improvements + +- Replace hardcoded filenames with `latest.json` parsing +- Add checksum/signature verification +- Publish one-step global installers for all platforms diff --git a/scripts/install.sh b/scripts/install.sh new file mode 100644 index 000000000..e2e3d6bce --- /dev/null +++ b/scripts/install.sh @@ -0,0 +1 @@ +echo "Coming soon. For now, you can download the latest desktop build from the website at [tinyhuman.ai/openhuman](https://tinyhuman.ai/openhuman)."