Skip to content

Commit

Permalink
READMEの修正・LICENSEの追加 (#295)
Browse files Browse the repository at this point in the history
リリースに向けて表記の作業を行いました。
  • Loading branch information
nokonoko1203 authored Feb 20, 2024
1 parent d36e36c commit 8f83455
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 19 deletions.
9 changes: 9 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) 2024 MLIT Japan.

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.
90 changes: 71 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,89 @@
# Nusamai: BRIDGE 都市デジタルツイン・GISコンバータの開発
# BRIDGE 都市デジタルツイン・GISコンバータ(PLATEAU-GIS-Converter)

[![Test Tauri App](https://github.com/MIERUNE/nusamai/actions/workflows/test_app.yml/badge.svg)](https://github.com/MIERUNE/nusamai/actions/workflows/test_app.yml)
[![Test Libraries](https://github.com/MIERUNE/nusamai/actions/workflows/test_libs.yml/badge.svg)](https://github.com/MIERUNE/nusamai/actions/workflows/test_libs.yml)
[![codecov](https://codecov.io/gh/MIERUNE/nusamai/graph/badge.svg?token=oa62wDWoqu)](https://codecov.io/gh/MIERUNE/nusamai)
[![Docs](https://github.com/MIERUNE/nusamai/actions/workflows/doc.yml/badge.svg)](https://mierune.github.io/nusamai/app/)

- Notion: [BRIDGE 都市デジタルツイン・GISコンバータの開発](https://www.notion.so/mierune/BRIDGE-GIS-461ba0355b3041619ed3f303a8b0166f)
- Rustdoc: <https://mierune.github.io/nusamai/app/>
PLATEAU-GIS-ConverterはCityGML形式の3D都市モデルを標準的なGISデータに変換するオーサリングツールです。本ツールでは3D都市モデルを以下の形式に変換することが可能です。

## Development
- GeoJSON
- Shapefile
- GeoPackage
- 3DTiles
- KML
- CZML
- Mapbox Vector Tiles

[静岡県沼津市の CityGML (v2)](https://www.geospatial.jp/ckan/dataset/plateau-22203-numazu-shi-2021/resource/758fe63a-b20f-4d5d-817d-c35eac530143) を読み込んで、3DTilesに変換した例

※todo: 画像を貼る

PLATEAU-GIS-Converterを利用することで、3D都市モデルを用いた様々な分析・開発を行うことが可能です。

- KMLによるGoogle Earthでの可視化
- GeoPackageによるQGIS等での解析
- Mapbox Vector Tilesを用いた大規模データの高速描画
- 3DTilesを利用したCesiumでの可視化
- など

PLATEAU-GIS-Converterは利用者アンケートを実施しています。
今後の開発の参考にするため、ユーザーの皆様の忌憚ないご意見をお聞かせください。

※todo: Googleフォームのリンクを貼る

## プラグインの利用方法

### 動作環境

※todo: 動作環境は要検証

- Windows(x86_64)
- MacOS(ARM)
- MacOS (Intel)

# 利用手順

※todo: リンク先を更新

- ソフトウェアの最新版は[Releaseページ]()からダウンロードしてください。
- 詳しい利用方法については、こちらの[マニュアル]() をご覧ください。

## ライセンス

- 本リポジトリはMITライセンスで提供されています。
- 本ソフトウェアの開発は[株式会社 MIERUNE](https://www.mierune.co.jp/)が行なっています。
- ソースコードおよび関連ドキュメントの著作権は国土交通省に帰属します。

## 注意事項

- 本リポジトリは参考資料として提供しているものです。動作の保証は行っておりません。
- 本リポジトリの内容は予告なく変更・削除する場合があります。
- 本リポジトリおよび本プラグインの利用により生じた損失及び損害等について、国土交通省はいかなる責任も負わないものとします。

## 開発者向け情報

### リポジトリ構成

- アプリケーション:
- [`app`](./app/) &mdash; Tauri による GUI 実装
- [`nusamai`](./nusamai/) &mdash; バックエンドおよびコマンドライン版実装
- [`app`](./app/) &mdash; Tauri による GUI 実装
- [`nusamai`](./nusamai/) &mdash; バックエンドおよびコマンドライン版実装
- 基盤・ユーティリティ:
- [`nusamai-geometry`](./nusamai-geometry/) &mdash; ジオメトリ型
- [`nusamai-projection`](./nusamai-projection/) &mdash; 投影法変換
- データソース:
- [`nusamai-citygml`](./nusamai-plateau/citygml/) &mdash; CityGML パーサ実装支援ライブラリ
- [`macros`](./nusamai-plateau/citygml/macros/) &mdash; パーサ導出用の proc macros
- [`nusamai-plateau`](./nusamai-plateau/) &mdash; PLATEAU 用の CityGML モデルおよびパーサ
- [`nusamai-citygml`](./nusamai-plateau/citygml/) &mdash; CityGML パーサ実装支援ライブラリ
- [`macros`](./nusamai-plateau/citygml/macros/) &mdash; パーサ導出用の proc macros
- [`nusamai-plateau`](./nusamai-plateau/) &mdash; PLATEAU 用の CityGML モデルおよびパーサ
- 変換先形式のための支援ライブラリ(本プロジェクトのユースケースが混入しないように開発する)
- [`nusamai-3dtiles`](./nusamai-3dtiles/) &mdash; 3D Tiles
- [`nusamai-mvt`](./nusamai-mvt/) &mdash; Mapbox Vector Tiles (MVT)
- [`nusamai-gpkg`](./nusamai-gpkg/) &mdash; GeoPackage
- [`nusamai-gltf`](./nusamai-gltf/) &mdash; glTF
- [`nusamai-geojson`](./nusamai-geojson/) &mdash; GeoJSON
- [`nusamai-kml`](./nusamai-kml/) &mdash; KML
- [`nusamai-czml`](./nusamai-kml/) &mdash; CZML
- [`nusamai-shapefile`](./nusamai-shapefile/) &mdash; Shapefile
- [`nusamai-3dtiles`](./nusamai-3dtiles/) &mdash; 3D Tiles
- [`nusamai-mvt`](./nusamai-mvt/) &mdash; Mapbox Vector Tiles (MVT)
- [`nusamai-gpkg`](./nusamai-gpkg/) &mdash; GeoPackage
- [`nusamai-gltf`](./nusamai-gltf/) &mdash; glTF
- [`nusamai-geojson`](./nusamai-geojson/) &mdash; GeoJSON
- [`nusamai-kml`](./nusamai-kml/) &mdash; KML
- [`nusamai-czml`](./nusamai-kml/) &mdash; CZML
- [`nusamai-shapefile`](./nusamai-shapefile/) &mdash; Shapefile

### 外部リポジトリ

Expand Down Expand Up @@ -78,9 +131,8 @@ npx tauri build

#### Coverage

Codecov: https://app.codecov.io/gh/MIERUNE/nusamai
Codecov: <https://app.codecov.io/gh/MIERUNE/nusamai>

```bash
cargo llvm-cov --workspace --exclude app --html --all-features
```

0 comments on commit 8f83455

Please sign in to comment.