Skip to content

docs: refactor README — clear structure, pure vector logo - #165

Merged
ULookup merged 2 commits into
mainfrom
docs/refactor-readme
Jun 20, 2026
Merged

ULookup merged 2 commits into
mainfrom
docs/refactor-readme

Conversation

@ULookup

@ULookup ULookup commented Jun 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • Replaced lockup logo with merak_logo_pure_vector.svg in assets/
  • Reorganized README into 6 clear sections: 简介 → 快速开始 → 功能全景 → 架构一览 → 开发指南 → 贡献
  • Added feature overview tables for Agent runtime, Worldbuilding, Knowledge Graph, WebUI, and Writer Agent
  • Split installation into "一键安装" (for creators) and "从源码构建" (for developers)
  • Removed duplicate content and consolidated dev guide
  • Cleaned up unused webui/src/assets/merak-logo-lockup.svg

Test plan

  • README renders correctly on GitHub
  • Logo image path resolves from repo root

ULookup added 2 commits June 19, 2026 17:59
…tor logo

- Add merak_logo_pure_vector.svg to assets/
- Remove unused merak-logo-lockup.svg from webui/src/assets/
- Reorganize README into 6 clear sections
- Add feature overview tables (Agent runtime, Worldbuilding, KG, WebUI, Writer)
- Distinguish installation paths: one-click install vs source build
- Remove duplicate content (LLM config, FAQ) and consolidate dev guide
@ULookup
ULookup merged commit ae455ab into main Jun 20, 2026
0 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant