Enhance README and add BUILDING guide

- Added an "Early Beta" note to the README to inform users about the development status. - Updated the download instructions in the README for clarity and added a script for global installation. - Introduced a new BUILDING.md file detailing the steps to build and install OpenHuman from source or via stable releases. - Added a placeholder install script to guide users on future installation options.
2026-07-27 21:08:00 +00:00 · 2026-03-30 23:27:18 -07:00
parent 75196438ee
commit d03dbb5fb5
3 changed files with 109 additions and 9 deletions
@@ -25,6 +25,8 @@
  "The Tet. What a brilliant machine" — Morgan Freeman as he reminisces about <a href="https://youtu.be/SveLVpqy_Rc?si=y83aZNokPiUjILN0&t=60">alien superintelligence</a> in the movie <em>Oblivion</em>
 </p>

+> **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)

@@ -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
@@ -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)."
				`@@ -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)."`