Skip to content

docs: update README.md#68

Open
tomoyay1622 wants to merge 1 commit into
lmntal:developfrom
tomoyay1622:fix/update-readme
Open

docs: update README.md#68
tomoyay1622 wants to merge 1 commit into
lmntal:developfrom
tomoyay1622:fix/update-readme

Conversation

@tomoyay1622

Copy link
Copy Markdown

概要
README.mdの Getting started および Develop セクションを現状に合わせて改訂しました。

変更内容

Getting started

従来は「ダウンロード可能」と一文のみだったものを、バンドル版ダウンロードページへの直リンクと起動方法(run.sh, run.bat)を明記する形に整理しました。

Develop — ローカルバンドルビルド手順を新規追加

LaViT本体に lmntal-compiler・SLIM・Graphene を組み合わせたバンドルをローカルで構築する手順を追記しました。対象読者は、公式リリースではなく手元の環境で各ツールを統合したい開発者です。

手順は以下の5章で構成されています。

  1. LaViT本体のビルド(ant jar)
  2. 旧公式バンドルからの lmntal/ 流用と不要ファイルの削除
  3. lmntal-compiler の組み込み(ant jar → lmntal/bin/ へコピー)
  4. SLIM の組み込み(git archive でソース抽出 → autogen.sh で configure 生成)
  5. Graphene の組み込み(sbt assembly → graphene.jar にリネーム)
    また、完成後のディレクトリ構成図を追加し、LaViTが各ツールをどのパスで参照するかが分かるようにしました。

リリース方法

既存の「リリース方法」セクションは Develop の末尾に移動・整形して保持しました。公式リリースはLMNtalグループが行う旨を冒頭に明記し、ローカルビルド手順と区別しています。

動機

従来のREADMEには開発者向けの情報がリリース手順しか記載されておらず、各ツールをどう組み合わせてビルドするかが不明瞭でした。本変更により、新たに開発に参加するメンバーがバンドル構築の全体像を把握しやすくなります。

Copilot AI review requested due to automatic review settings February 21, 2026 00:53

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the README.md documentation to provide comprehensive guidance for both end users and developers. The changes include adding direct download links, clarifying the startup process, and introducing detailed local bundle build instructions.

Changes:

  • Added Getting Started section with direct download links and startup instructions (run.sh/run.bat)
  • Introduced Develop section with step-by-step instructions for building a local LaViT bundle integrating lmntal-compiler, SLIM, and Graphene
  • Reorganized and clarified the release process section, distinguishing it from local development workflows

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants