dotnet readme

KLab · Nov 10, 2022 · fcf9438 · fcf9438
1 parent b7f95eb
commit fcf9438
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.markdown-preview.html
diff --git a/_doc/csharp_client.md b/_doc/csharp_client.md
@@ -17,12 +17,12 @@
 WSNet2を利用するのに必要なC#コードは[`wsnet2-unity/Assets/WSNet2`](../wsnet2-unity/Assets/WSNet2)以下に置かれています。
 Unityの場合はこのディレクトリを`Assets`以下にコピーしてください。
 
-.Netアプリケーションで利用する場合は、[`wsnet2-unity/Assets/WSNet2/Scripts/Core`](../wsnet2-unity/Assets/WSNet2/Scripts/Core)以下のファイルをプロジェクト（*.csproj）に含めてください。
+.NETアプリケーションで利用する場合は、[`wsnet2-unity/Assets/WSNet2/Scripts/Core`](../wsnet2-unity/Assets/WSNet2/Scripts/Core)以下のファイルをプロジェクト（*.csproj）に含めてください。
 
 ## `WSNet2Client`の利用
 
 WSNet2の利用は[`WSNet2Client`クラス](wsnet2client.md)を利用したロビーへのリクエスト（部屋作成・検索・入室）から始めます。
-これは、Unityでは`WSNet2Service.Instance.GetClient()`で取得できるほか、.Netアプリケーションでは直接`new WSNet2Client(...)`します。
+これは、Unityでは`WSNet2Service.Instance.GetClient()`で取得できるほか、.NETアプリケーションでは直接`new WSNet2Client(...)`します。
 
 WSNet2Clientの利用には認証情報が必要になります。
 詳しくは[WSNet2のユーザ認証](user_auth.md)を参照して下さい。

diff --git a/_doc/user_auth.md b/_doc/user_auth.md
@@ -5,8 +5,7 @@
 クライアントは、認証データをゲームAPIサーバから取得し、その認証データを与えたWSNet2Clientを用いて、WSNet2へアクセスします。
 WSNet2は認証データを検証することで、ユーザIDが正規のものかを確認します。
 
-認証データには数分程度の有効期限を設けておきます
-（[設定ファイルのLobby.authdata_expire](server_setup.md#ファイル内容)で指定）。
+認証データには数分程度の有効期限を設けておきます（[設定ファイルのLobby.authdata_expire](server_setup.md#ファイル内容)で指定）。
 期限を過ぎたときには、ゲームAPIサーバから再度取得します。
 
 ## ゲームAPIサーバの手順
@@ -53,7 +52,7 @@ auth_data = Base64(nonce + timestamp + hmac)
 WSNet2（Lobby）へのアクセスは、[`WSNet2.WSNet2Client`](../wsnet2-unity/Assets/WSNet2/Scripts/Core/WSNet2Client.cs)クラスを利用します。
 
 Unityの場合、[`WSNet2Service.Instance.GetClient()`](../wsnet2-unity/Assets/WSNet2/Scripts/WSNet2Service.cs#L42-L53)の引数として認証データを渡します。
-.Netの場合、[`WSNet2Client`のコンストラクタ](../wsnet2-unity/Assets/WSNet2/Scripts/Core/WSNet2Client.cs#L26-L34)に認証データを渡します。
+.NETの場合、[`WSNet2Client`のコンストラクタ](../wsnet2-unity/Assets/WSNet2/Scripts/Core/WSNet2Client.cs#L26-L34)に認証データを渡します。
 
 ### 認証データの更新
 

diff --git a/wsnet2-dotnet/README.md b/wsnet2-dotnet/README.md
@@ -0,0 +1,17 @@
+# .NETのサンプルとテスト
+
+## WSNet2.Client
+
+CUIで入力メッセージを送受信するサンプルです。
+
+単純な機能の動作確認に利用できます。
+
+## WSNet2.Core.Test
+
+C#実装のユニットテストです。
+
+## WSNet2.Sample
+
+Unityのサンプルと連携するMasterClientとBotのサンプルです。
+
+使い方は[README.mdの使ってみる](../README.md#使ってみる)を見てください。