Skip to content

docs: connect project metadata to public website #2924

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

Draft
hqhq1025 wants to merge 1 commit into
base: main
Choose a base branch
from
+34 −6
Draft

docs: connect project metadata to public website #2924

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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
[![docs](https://img.shields.io/badge/docs-%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87-blue?logo=googletranslate&logoColor=white)](./README.zh-CN.md)

[Website](https://maka-agent.com/) · [Download](https://maka-agent.com/download/) · [Documentation](https://maka-agent.com/docs/) · [Architecture](https://maka-agent.com/architecture/) · [Latest release](https://github.com/maka-agent/maka-agent/releases/latest)

![Maka — Your work. Your agent.](./.github/assets/maka-hero.en.png)

**A local-first Agent workspace built for real work.**
Expand Down Expand Up @@ -55,16 +57,18 @@ Read [Maka Backend Architecture](./ARCHITECTURE.md) for the complete design.

## Quick start

### Download Desktop for macOS
### Download Desktop

The signed and notarized Apple Silicon macOS build and an unsigned Windows x64 preview are available from the [Maka download page](https://maka-agent.com/download/) and [GitHub Releases](https://github.com/Maka-Agent/maka-agent/releases/latest).

The signed and notarized Desktop app is available from [GitHub Releases](https://github.com/Maka-Agent/maka-agent/releases/latest) for Apple Silicon Macs only (`arm64`).
On macOS:

1. Download `Maka-<version>-mac-arm64.dmg`;
2. Open the DMG and drag Maka to Applications;
3. Install `ripgrep` with `brew install ripgrep` to enable Runtime's `Grep` tool;
4. Launch Maka and configure your own model connection under `Settings → Models`.

Computer Use is not included in this first public build. Intel Macs, Windows, and Linux packages are not supported yet.
The Windows x64 installer is currently unsigned and may trigger SmartScreen. Verify it against the attached `.sha256` file before opening it. Intel Macs and Linux do not have published installers. Computer Use is not included in the current release.

### Requirements

Expand Down
10 changes: 7 additions & 3 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
[![docs](https://img.shields.io/badge/docs-English-blue?logo=googletranslate&logoColor=white)](./README.md)

[官网](https://maka-agent.com/zh/) · [下载](https://maka-agent.com/download/) · [文档](https://maka-agent.com/docs/) · [架构](https://maka-agent.com/architecture/) · [最新版本](https://github.com/maka-agent/maka-agent/releases/latest)

![Maka——你的工作，你的 Agent。](./.github/assets/maka-hero.zh-CN.png)

**一个为真实工作而生的本地优先 Agent 工作台。**
Expand Down Expand Up @@ -55,16 +57,18 @@ Maka 不只回答问题。它可以在受控权限下阅读项目、执行工具

## 快速开始

### 下载 macOS 桌面版
### 下载桌面版

已签名并完成 Apple 公证的 Apple Silicon macOS 版本，以及未签名的 Windows x64 预览版，可以从 [Maka 下载页](https://maka-agent.com/download/) 或 [GitHub Releases](https://github.com/Maka-Agent/maka-agent/releases/latest) 获取。

已签名并完成 Apple 公证的桌面应用可从 [GitHub Releases](https://github.com/Maka-Agent/maka-agent/releases/latest) 下载，目前仅支持 Apple Silicon Mac（`arm64`）。
在 macOS 上：

1. 下载 `Maka-<version>-mac-arm64.dmg`；
2. 打开 DMG，将 Maka 拖入“应用程序”；
3. 执行 `brew install ripgrep`，启用 Runtime 的 `Grep` 工具；
4. 启动 Maka，在`设置 → 模型`中配置自己的模型连接。

首个公开版本不包含 Computer Use，暂不支持 Intel Mac、Windows 和 Linux 安装包。
Windows x64 安装包目前未签名，首次启动可能触发 SmartScreen。打开前请使用 Release 中附带的 `.sha256` 文件校验。Intel Mac 和 Linux 暂无发布安装包。当前版本不包含 Computer Use。

### 环境要求

Expand Down
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This page is the authority map for Maka documentation. Code and contract tests remain the final authority when documentation disagrees with the implementation.

Public entry points: [website](https://maka-agent.com/) · [download](https://maka-agent.com/download/) · [documentation index](https://maka-agent.com/docs/) · [architecture overview](https://maka-agent.com/architecture/) · [security overview](https://maka-agent.com/security/)

## Where information belongs

- Root and package READMEs describe stable product entry points, public seams, and local ownership.
Expand Down
18 changes: 18 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
{
"name": "maka",
"version": "0.1.10",
"description": "Maka — local-first AI desktop assistant",
"homepage": "https://maka-agent.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/maka-agent/maka-agent.git"
},
"bugs": {
"url": "https://github.com/maka-agent/maka-agent/issues"
},
"keywords": [
"ai-agent",
"desktop-app",
"local-first",
"agent-runtime",
"electron",
"cli",
"tui"
],
"license": "Apache-2.0",
"private": true,
"engines": {
Expand Down
Loading