from-the-earth / canbeta Goto Github PK

Is your feature request related to a problem? Please describe.

現状白紙状態（https://from-the-earth.github.io/canbeta/dev/）．

Describe the solution you'd like

• canbeta の開発の概要を記載する
• チーム開発のワークフローを記載する
• コントリビュート方法について記載する
• ハードウェアについて記載する
• リポジトリのディレクトリ構造について記載する
• 依存関係について記載する
• 開発環境およびその設定について記載する
• 開発中の Python パッケージについて記載する
  • ミッションのフローチャートを記載する
  • ノードの種類について記載する
  • アプリケーションの設定について記載する

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

現在アプリケーションの設定は，canbeta.setting モジュールによって定義されている．しかし，この状態ではアプリケーションのインストール後の設定の変更が出来ない状態になっており，これは実行時に大きな支障をもたらしている．

Describe the solution you'd like

上記問題を解決するために，gileum を導入する．gileum の特徴は設定ファイルを Python スクリプトとして記述出来る点であり，さらに内部で pydantic を使用することにより型検査などの設定値のバリデーションを行うことが出来る．この gileum を使用することで，容易にアプリケーションに設定ファイルの機構を設けるとことが出来ると考えられる．

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

ホームページがダサい（というか何もない）．

Describe the solution you'd like

以下の情報を記載する：

• サイトの概要
• アプリケーションのインストール方法
• 開発者向けの案内
• 問い合わせ先の案内

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

• README の情報が薄い
• リポジトリサイトへの案内がない

Describe the solution you'd like

• 基本的な情報は全てリポジトリサイトでまとめられているので，訪問者をリポジトリサイトに誘導するようにする
• 開発者向けの案内については別途記載しておく

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe.

現在白紙状態（https://from-the-earth.github.io/canbeta/project/）．

Describe the solution you'd like

• プロジェクトの概要を記載する
• ミッションの概要を記載する
• 大まかなプロジェクトの計画・日程について記載する

Describe alternatives you've considered

Additional context