Skip to content

Docs: point app builders to the contestant path; fix the quoted makepad pin #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ymote merged 1 commit into from
Sep 26, 2026
Merged

Docs: point app builders to the contestant path; fix the quoted makepad pin #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

English | [简体中文](README.zh-CN.md)

> **Building an OctoSense app?** You do not need this repository: it is the standalone OctoScript language runtime (VM, capabilities, workflows, LSP). An app's `main.splash` runs on the Makepad-based runtime that the app tools set up for you, and the language an app may use is documented in [SCRIPT-API](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/SCRIPT-API.md). Start from the [OctoSense organization profile](https://github.com/OctoSense-org)'s reading order: [OctoScript-App-Design-Flow `AGENTS.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/AGENTS.md) → [`flows/README.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/flows/README.md) → [`docs/QUICKSTART.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/QUICKSTART.md).

Octoscript is a capability-first scripting runtime for dynamic workflows, tool
orchestration, and data transformation. It starts from the Makepad Octoscript VM
and keeps UI support optional rather than making UI the language boundary.
Expand Down
2 changes: 2 additions & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[English](README.md) | 简体中文

> **要开发 OctoSense 应用？** 你不需要这个仓库：它是独立的 OctoScript 语言运行时（VM、能力、工作流、LSP）。应用的 `main.splash` 运行在应用工具为你准备好的 Makepad 运行时上，应用可用的语言与 API 见 [SCRIPT-API](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/SCRIPT-API.md)。请按 [OctoSense 组织主页](https://github.com/OctoSense-org)给出的顺序阅读：[OctoScript-App-Design-Flow `AGENTS.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/AGENTS.md) → [`flows/README.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/flows/README.md) → [`docs/QUICKSTART.md`](https://github.com/OctoSense-org/OctoScript-App-Design-Flow/blob/main/docs/QUICKSTART.md)。

Octoscript 是一个以能力（capability）为先的脚本运行时，面向动态工作流、工具编排和数据转换。它以 Makepad Octoscript VM 为起点，把 UI 支持作为可选项，而不是让 UI 成为语言的边界。

## 当前基线
Expand Down
2 changes: 1 addition & 1 deletion UPSTREAM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ parser, derive crate, and their leaf dependencies come from the `octoscript`
branch of the OctoSense fork of Makepad, consumed as a pinned git dependency:

```toml
makepad-script = { git = "https://github.com/OctoSense-org/makepad.git", rev = "3090964f9eba54c9384c0b55d2b4869c80305f7b" }
makepad-script = { git = "https://github.com/OctoSense-org/makepad.git", rev = "6e5898fecbe5931c16fb7b1e54357104dd54e825" }
```

The pin appears in exactly two manifests, `crates/octoscript-core/Cargo.toml`
Expand Down
Loading