mirror of
https://github.com/nejimakibird/model-weave.git
synced 2026-07-22 06:51:24 +00:00
Add MIT license and quick start docs
This commit is contained in:
parent
83fb26c019
commit
674e069a60
3 changed files with 46 additions and 0 deletions
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2026 nejimakibird
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
13
README.md
13
README.md
|
|
@ -105,6 +105,15 @@ Manual installation outline:
|
|||
3. Copy the plugin files into `.obsidian/plugins/model-weave/` in your vault.
|
||||
4. Enable Model Weave in Obsidian Desktop.
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Install and enable Model Weave in Obsidian Desktop.
|
||||
2. Open a file from [samples/](samples/) or create a Markdown model file in your vault.
|
||||
3. Add frontmatter such as `type: class`, `type: er_entity`, or `type: dfd_diagram`.
|
||||
4. Open the Model Weave Viewer and confirm the parsed preview.
|
||||
5. Use Custom mode for detailed review where available.
|
||||
6. Use Mermaid mode for overview, relationship, and flow views where available.
|
||||
|
||||
## Viewer behavior
|
||||
|
||||
- Shared Viewer features include zoom, fit, `100%`, pan, diagnostics, upper/lower resizable panels, and PNG export.
|
||||
|
|
@ -188,3 +197,7 @@ Useful manual checks:
|
|||
- This repository contains samples and test-oriented files side by side.
|
||||
- `testdata/` is for warning/unsupported/diagnostic checks and is not the main public sample set.
|
||||
- Some format docs are still pending publication as standalone spec pages. The current docs index marks those cases explicitly instead of inventing partial specs here.
|
||||
|
||||
## License
|
||||
|
||||
Model Weave is released under the [MIT License](LICENSE).
|
||||
|
|
|
|||
12
README_JP.md
12
README_JP.md
|
|
@ -96,6 +96,14 @@ toolbar での選択は一時的な表示 override で、Markdown や frontmatte
|
|||
3. vault の `.obsidian/plugins/model-weave/` に配置する
|
||||
4. Obsidian Desktop で plugin を有効化する
|
||||
|
||||
## クイックスタート
|
||||
|
||||
1. Obsidian Desktop に Model Weave をインストールして有効化します。
|
||||
2. [samples/](samples/) を参照またはコピーするか、新しい Markdown モデルファイルを作成します。
|
||||
3. frontmatter に `type: class`、`type: er_entity`、`type: dfd_diagram` などを指定します。
|
||||
4. Model Weave Viewer で開いてプレビューを確認します。
|
||||
5. 詳細確認は Custom、全体俯瞰や関係把握は Mermaid を使います。
|
||||
|
||||
## Viewer の考え方
|
||||
|
||||
- shared Viewer features として zoom / fit / `100%` / pan / diagnostics / upper-lower resizable layout / PNG export を持ちます
|
||||
|
|
@ -162,3 +170,7 @@ V0.7 の `dfd_diagram.Objects` 推奨列:
|
|||
- `testdata/` は diagnostics / compatibility 確認用です
|
||||
- mobile 向け最適化は現時点では前提にしていません
|
||||
- public release に向けて docs と samples を段階的に整理中です
|
||||
|
||||
## ライセンス
|
||||
|
||||
Model Weave は [MIT License](LICENSE) で公開します。詳細は `LICENSE` を参照してください。
|
||||
|
|
|
|||
Loading…
Reference in a new issue