docs: update README.md#68
Open
tomoyay1622 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
README.mdの Getting started および Develop セクションを現状に合わせて改訂しました。
変更内容
Getting started
従来は「ダウンロード可能」と一文のみだったものを、バンドル版ダウンロードページへの直リンクと起動方法(run.sh, run.bat)を明記する形に整理しました。
Develop — ローカルバンドルビルド手順を新規追加
LaViT本体に lmntal-compiler・SLIM・Graphene を組み合わせたバンドルをローカルで構築する手順を追記しました。対象読者は、公式リリースではなく手元の環境で各ツールを統合したい開発者です。
手順は以下の5章で構成されています。
また、完成後のディレクトリ構成図を追加し、LaViTが各ツールをどのパスで参照するかが分かるようにしました。
リリース方法
既存の「リリース方法」セクションは Develop の末尾に移動・整形して保持しました。公式リリースはLMNtalグループが行う旨を冒頭に明記し、ローカルビルド手順と区別しています。
動機
従来のREADMEには開発者向けの情報がリリース手順しか記載されておらず、各ツールをどう組み合わせてビルドするかが不明瞭でした。本変更により、新たに開発に参加するメンバーがバンドル構築の全体像を把握しやすくなります。