From 23eaed9150d38efe35ab920f2a4d5aa044816cbb Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:23:06 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 147 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..d6d47a2 --- /dev/null +++ b/README.en.md @@ -0,0 +1,147 @@ +[![logo](./website/public/aholo-logo.svg)](https://aholojs.dev/) + +# Aholo Viewer + +![Build Status](https://github.com/manycoretech/aholo-viewer/actions/workflows/check.yaml/badge.svg?branch=master) +[![aholo-viewer](https://img.shields.io/npm/v/@manycore/aholo-viewer?label=aholo-viewer)](https://www.npmjs.com/package/@manycore/aholo-viewer) +[![splat-transform](https://img.shields.io/npm/v/@manycore/aholo-splat-transform?label=splat-transform)](https://www.npmjs.com/package/@manycore/aholo-splat-transform) +[![license](https://img.shields.io/npm/l/@manycore/aholo-viewer)](#license) + +Monorepo for the Aholo Viewer package and its documentation website. + +## What is Aholo Viewer + +Aholo Viewer is a high performance Renderer for 3DGS and Mesh. It uses `Chunked Steaming Lod` schema to handle huge 3DGS. + +## Usage + +Follow the [Manual](https://aholojs.dev/en-US/manual/getting-started/). + +> If everything goes well you will see [this](https://jsfiddle.net/hs6Lp038/) + +For npm package usage, see [`packages/renderer/README.md`](./packages/renderer/README.md). + +For AI-assisted integration, use [`docs/ai/skills/use-aholo-viewer/SKILL.md`](./docs/ai/skills/use-aholo-viewer/SKILL.md). + +## Build Requirements + +- Node: >= 22.22.1 +- pnpm(corepack preferred) + +## Clone this repository + +This repository contains some submodules as dependencies, use following command to clone the repository. + +```bash +git clone --recurse-submodules https://github.com/manycoretech/aholo-viewer.git +``` + +## Structure + +```text +aholo-viewer/ + AGENTS.md Agent-facing project guide + website/ Astro website: home, manual, examples, API docs, playground + packages/renderer/ Renderer TypeScript source package + scripts/ Shared build and documentation scripts + docs/ Architecture and AI collaboration notes + external/ Required upstream and workspace dependency sources + .codex/skills/ Project-local Codex skills +``` + +## Commands + +Run workspace commands from the repository root: + +```bash +pnpm install +pnpm dev +pnpm check +pnpm build +pnpm preview +``` + +Targeted root commands: + +```bash +pnpm build:renderer +pnpm build:website +pnpm check:content +pnpm check:renderer +pnpm check:website +pnpm docs:api +``` + +## Project Docs + +- `AGENTS.md`: quick guide for AI agents and future coding sessions +- `docs/architecture.md`: current workspace structure and dependency flow +- `docs/ai/vibe-coding-guide.md`: detailed guide for future AI-assisted changes, writing style, and handoffs +- `docs/ai/skills/use-aholo-viewer/SKILL.md`: external npm package usage guide for AI coding agents +- `.codex/skills/`: local Codex skills split by repo area + +## Codex Skills + +Project-local skills live in `.codex/skills/`. Use `AGENTS.md` for the current skill map. + +## External Source + +`external/egs-core` is a required upstream submodule. `external/splat-transform` is a required workspace package and must stay in the repo. Treat upstream code under `external/` as read-only unless a task explicitly targets that package. + +## API Docs + +API docs are generated from `packages/renderer/src/index.ts` into an ignored local directory: + +```text +website/.generated/api/ +``` + +`pnpm dev`, `pnpm build`, and `pnpm check` regenerate them automatically. Run the generator directly when you want to refresh the local TypeDoc HTML and manifest without starting the site: + +```bash +pnpm docs:api +``` + +## Content Checks + +`pnpm check:content` validates manual locale parity, empty pages, example source pairs, manual image references, orphan manual images, and internal-only documentation links. It is also part of `pnpm check` and `pnpm check:website`. + +## Playground URLs + +The Playground keeps edited code in the URL with `lz-string`: + +```text +/zh-CN/playground/?example=basic-scene&code= +``` + +Opening a URL with `code` restores the editor content automatically. + +Examples are stored in `website/src/content/examples/` as paired `.json` metadata and `.ts` source files. The same slug powers the Examples pages and Playground `example` query parameter. + +## Contributors + + + + + +Made with [contrib.rocks](https://contrib.rocks). + +## Star History + + + + + + Star History Chart + + + +## Useful Links + +- [Discussions](https://github.com/manycoretech/aholo-viewer/discussions) +- [Official website](https://aholojs.dev/) +- [CHANGELOG](./packages/renderer/CHANGELOG.md) + +## License + +[MIT License](./LICENSE).