Skip to content

Commit

Permalink
指摘があったので、READMEを更新 (#355)
Browse files Browse the repository at this point in the history
タイトルの通りです。

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit


- **新機能**
	- アプリケーションにメイン画面画像を追加しました。
- **ドキュメント**
	- 「システム概要」セクションを「機能一覧」に名称変更しました。
	- 「利用技術」セクションをUIと主要ロジック技術で詳細に分けて再構成しました。
	- サポートされているオペレーティングシステム、CPU、メモリ、ネットワーク、およびストレージ要件の詳細を拡張しました。

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
nokonoko1203 authored Feb 28, 2024
1 parent bf01ca3 commit d8b41ba
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:

- name: Set optimization options
run: |
echo '\n[profile.release]' >> Cargo.toml
echo '[profile.release]' >> Cargo.toml
echo 'lto = true' >> Cargo.toml
echo 'panic = "abort"' >> Cargo.toml
Expand Down
38 changes: 31 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@

PLATEAU GIS Converter は、[PLATEAU](https://www.mlit.go.jp/plateau/)プロジェクトのCityGML形式の3D都市モデルを他の一般的なGISデータ形式に変換するソフトウェアです。

アプリケーションのメイン画面:

![alt text](docs/resources/README_image-1.png)

[東京都23区の CityGML (v2)](https://www.geospatial.jp/ckan/dataset/plateau-tokyo23ku-2022/resource/55c72dd0-32eb-4107-9526-71fc0af8d50f3) を読み込んで、3DTilesに変換した例:

![alt text](docs/resources/README_image.png)
Expand Down Expand Up @@ -50,16 +54,36 @@ PLATEAUの標準仕様に準拠したCityGML2.0形式の3D都市モデルは、

## 5. 利用技術

- UI
- [Tauri](https://github.com/tauri-apps/tauri)
- [Svelte](https://svelte.dev/)
- バックエンド
- [Rust](https://www.rust-lang.org/)
利用技術は以下の通りです。

### UI

UIの構築には以下の技術を利用しています。

- ネイティブアプリケーション構築フレームワーク: [Tauri](https://github.com/tauri-apps/tauri)
- UI構築フレームワーク: [Svelte](https://svelte.dev/)

### メインロジック

メインロジックは全てRustで実装しています。

- プログラミング言語: [Rust](https://www.rust-lang.org/)

## 6. 動作環境

- Windows(Intel)
- macOS(Apple Silicon, Intel)
- 本ソフトウェアは以下の環境で動作することを想定しています。
- OS:
- Windows(Intel)
- macOS(Apple Silicon)
- CPU:
- 特に制限はありませんが、変換対象の範囲や出力形式によっては処理時間に大きな影響があります
- メモリ:
- 特に制限はありませんが、変換対象が広い場合、変換時には多くのメモリが必要になります
- ネットワーク:
- インターネット接続は不要です
- ストレージ:
- インストールには30MB程度の空き容量が必要です
- 変換時には、変換元データとほぼ同等、もしくはそれ以上の空き容量が必要です

## 7. 本リポジトリのフォルダ構成

Expand Down
Binary file added docs/resources/README_image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d8b41ba

Please sign in to comment.