diff --git a/README.md b/README.md index e78fc12..be1e7ec 100644 --- a/README.md +++ b/README.md @@ -12,34 +12,37 @@ 1. リポジトリをクローンします。 - git clone https://github.com/yourusername/VQCalendarAttention.git + git clone https://git.omhouse.mydns.jp/git/syuji/VQCalendarAttention.git 2. プロジェクトフォルダに移動し、必要なNuGetパッケージをインストールします。 - cd VQCalendarAttention + cd VQCalendarAttention/VQCalendarAttention dotnet restore ## 設定 -1. GoogleカレンダーAPIの認証情報を`credentials.json`ファイルとしてプロジェクトフォルダに保存します。 +このプロジェクトでは、いくつかの環境変数を設定する必要があります。これらの環境変数は .env ファイルに記述してください。プロジェクトのルートディレクトリに .env ファイルを作成し、以下の環境変数を設定します。 -2. `appsettings.json`ファイルを作成し、以下の内容を記述します。適切な値に置き換えてください。 - -```json -{ - "GoogleCalendar": { - "CalendarId": "your_calendar_id" - }, - "Discord": { - "WebhookUrl": "your_discord_webhook_url" - }, - "CronJob": { - "CronExpression": "0 9 * * *", - "TimeZone": "UTC" - } -} ``` +DISCORD_WEBHOOK_URL=your_discord_webhook_url +DISCORD_ROLE_ID=your_discord_role_id +CALENDAR_ID=your_calendar_id +CREDENTIALS_FILE_PATH=your_credentials_file_path +CRON_PATTERN_IMPORTANT=your_cron_pattern_important +CRON_PATTERN_NEXTDAY=your_cron_pattern_nextday +``` + +各環境変数の説明: + +- DISCORD_WEBHOOK_URL: DiscordのWebhook URLです。通知を送信するチャンネルに対応するWebhookを作成し、そのURLを指定してください。 +- DISCORD_ROLE_ID: メンションを送信するDiscordのロールIDです。メンションを送りたいロールのIDを指定してください。 +- CALENDAR_ID: GoogleカレンダーのIDです。通知を取得したいカレンダーのIDを指定してください。 +- CREDENTIALS_FILE_PATH: GoogleカレンダーAPIの認証情報(サービスアカウントキー)ファイルへのパスです。適切なパスを指定してください。 +- CRON_PATTERN_IMPORTANT: [重要]タグが付いた予定の通知を送信するタイミングを指定するCRONパターンです。 +- CRON_PATTERN_NEXTDAY: 翌日の予定の通知を送信するタイミングを指定するCRONパターンです。 + +.env ファイルを作成したら、プログラムを実行する前に、適切な値に置き換えてください。 ## 実行方法