ドキュメントの最新化

nokonoko1203 commented 2 months ago

Close #636

What I did（変更内容）

マニュアルを改修

Notes（連絡事項）

None / なし

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

このプルリクエストでは、ドキュメントの修正が行われました。主に、用語の一貫性を保つために「MacOS」を「macOS」に変更し、いくつかの文法的な調整が加えられました。また、新しいコマンドラインオプションが追加され、具体的な出力ファイル形式の設定が導入されました。全体として、ドキュメントの可読性と明確さが向上しました。

Changes

ファイル	変更の概要
docs/manual/install.md	「MacOS」を「macOS」に変更、フォルダ名の修正、画像参照のファイル名を変更。
docs/manual/use_command_line.md	「MacOS」を「macOS」に変更、コマンドラインオプション`-t`と`-o`を追加、例を追加して使用法を明確化。
docs/manual/use_gui.md	「MacOS」を「macOS」に変更、文章の簡潔化、GeoPackageファイルの変換に関する説明を明確化、OBJフォーマットの詳細を追加。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CommandLine
    participant GUI
    participant Output

    User->>CommandLine: 新しいコマンドを入力
    CommandLine->>Output: 出力ファイルを生成
    User->>GUI: GUIを使用して設定を変更
    GUI->>Output: 出力ファイルを生成

Poem

うさぎの耳で聞いたよ、
文書が新しくなったと、
みんなのために、
より分かりやすく、
さあ、跳ねよう、
新しい道を探しに！ 🐇✨

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Additional details and impacted files

| [Components](https://app.codecov.io/gh/MIERUNE/plateau-gis-converter/pull/654/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MIERUNE) | Coverage Δ | | |---|---|---| | [GUI](https://app.codecov.io/gh/MIERUNE/plateau-gis-converter/pull/654/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MIERUNE) | `∅ <ø> (∅)` | | | [Backend](https://app.codecov.io/gh/MIERUNE/plateau-gis-converter/pull/654/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MIERUNE) | `74.01% <ø> (ø)` | | | [Libraries](https://app.codecov.io/gh/MIERUNE/plateau-gis-converter/pull/654/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MIERUNE) | `89.71% <ø> (-0.02%)` | :arrow_down: |

:loudspeaker: Thoughts on this report? Let us know!

MIERUNE / plateau-gis-converter