Skip to content

Commit

Permalink
add desc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jiowchern
jiowchern committed Jul 11, 2021
1 parent 923492f commit 173ad46
Show file tree
Hide file tree
Showing 20 changed files with 31 additions and 119 deletions.
28 changes: 18 additions & 10 deletions README.md
View file
Expand Up @@ -154,7 +154,8 @@ Sample/Common>dotnet new classlib
Add references to **Common.csproj**.
```xml
<ItemGroup>
<ProjectReference Include="Regulus\Regulus.Remote\Regulus.Remote.csproj" />
<PackageReference Include="Regulus.Remote" Version="0.1.9.1" />
<PackageReference Include="Regulus.Remote.Tools.Protocol" Version="0.1.9.1"/>
</ItemGroup>
```
Add a sample file,**IFoo.cs**.
Expand All @@ -173,17 +174,24 @@ Sample/Protocol>dotnet new classlib
Add references to **Protocol.csproj**.
```xml
<ItemGroup>
<ProjectReference Include="Regulus\Regulus.Remote\Regulus.Remote.csproj" />
<ProjectReference Include="Regulus\Regulus.Serialization\Regulus.Serialization.csproj" />
<PackageReference Include="Regulus.Serialization" Version="0.1.9.1" />
<ProjectReference Include="Common\Common.csproj" />
</ItemGroup>
```
**Generation the protocol code.**
Use ```Regulus.Application.Protocol.CodeWriter.dll``` to generate code to **Protocol** project.
```powershell
Sample>dotnet run --project Regulus/Regulus.Application.Protocol.CodeWriter --common Common.dll --output Protocol
```
At this point, there are two projects, **Common.csproj** and **Protocol.csproj**.

### Generation the protocol code.
In ```Common.csproj``` specify the code export path.
```xml
<!-- Common.csproj -->
<ItemGroup>
<PackageReference Include="Regulus.Remote" Version="0.1.9.1" />
<PackageReference Include="Regulus.Remote.Tools.Protocol" Version="0.1.9.1"/>
<!-- new -->
<RegulusProtocolOutputDir Include="..\Protocol\" />
</ItemGroup>
```
Building **Common** in this way generates a code to **Protocol**.

#### Server
The following example sets up a server in console.
Expand All @@ -193,7 +201,7 @@ Sample/Server>dotnet new console
Add references to **Server.csproj**.
```xml
<ItemGroup>
<ProjectReference Include="Regulus\Regulus.Remote.Server\Regulus.Remote.Server.csproj" />
<PackageReference Include="Regulus.Remote.Server" Version="0.1.9.1" />
<ProjectReference Include="..\Common\Common.csproj" />
</ItemGroup>
```
Expand Down Expand Up @@ -240,7 +248,7 @@ Sample/Client>dotnet new console
Add references to **Client.csproj**.
```xml
<ItemGroup>
<ProjectReference Include="Regulus\Regulus.Remote.Server\Regulus.Remote.Client.csproj" />
<PackageReference Include="Regulus.Remote.Client" Version="0.1.9.1" />
<ProjectReference Include="..\Common\Common.csproj" />
</ItemGroup>
```
Expand Down
1 change: 1 addition & 0 deletions Regulus.Application.Protocol.CodeWriter/Regulus.Application.Protocol.CodeWriter.csproj
View file
Expand Up @@ -9,6 +9,7 @@
<Authors>jc</Authors>
<PackAsTool>true</PackAsTool>
<ToolCommandName>Regulus.Application.Protocol.CodeWriter</ToolCommandName>
<Description>regulus remote protocol create tool.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions Regulus.Application.TemplateCreator/Regulus.Application.TemplateCreator.csproj
View file
Expand Up @@ -8,6 +8,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>quick project creation tool.</Description>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20253.1" />
Expand Down
1 change: 1 addition & 0 deletions Regulus.Network/Regulus.Network.csproj
View file
Expand Up @@ -6,6 +6,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>network kits.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion Regulus.Remote.Client/Regulus.Remote.Client.csproj
View file
Expand Up @@ -7,7 +7,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>

<Description>client.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions Regulus.Remote.Ghost/Regulus.Remote.Ghost.csproj
View file
Expand Up @@ -5,6 +5,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>frontend lib.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions Regulus.Remote.Protocol/Regulus.Remote.Protocol.csproj
View file
Expand Up @@ -6,6 +6,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>protocol create lib.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions Regulus.Remote.Reactive/Regulus.Remote.Reactive.csproj
View file
Expand Up @@ -6,6 +6,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>rx integration kit.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions Regulus.Remote.Server/Regulus.Remote.Server.csproj
View file
Expand Up @@ -7,6 +7,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>server.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion Regulus.Remote.Soul/Regulus.Remote.Soul.csproj
View file
Expand Up @@ -6,7 +6,7 @@
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Company></Company>
<Description>backend lib.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions Regulus.Remote.Standalone/Regulus.Remote.Standalone.csproj
View file
Expand Up @@ -7,6 +7,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>standalone.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
11 changes: 0 additions & 11 deletions Regulus.Remote.Tools.Protocol/Assets/build/Regulus.Remote.Tools.Protocol.targets
View file

This file was deleted.

5 changes: 0 additions & 5 deletions ...us.Remote.Tools.Protocol/Assets/buildMultiTargeting/Regulus.Remote.Tools.Protocol.targets
View file

This file was deleted.

Empty file removed Regulus.Remote.Tools.Protocol/Assets/readme.txt
View file
Empty file.
33 changes: 0 additions & 33 deletions Regulus.Remote.Tools.Protocol/CodeGenerator.cs
View file

This file was deleted.

46 changes: 0 additions & 46 deletions Regulus.Remote.Tools.Protocol/Regulus.Remote.Tools.Protocol.csproj
View file

This file was deleted.

1 change: 1 addition & 0 deletions Regulus.Remote/Regulus.Remote.csproj
View file
Expand Up @@ -6,6 +6,7 @@
<Version>0.1.9.1</Version>
<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>
<Description>remote core.</Description>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\Regulus.Network\Regulus.Network.csproj" />
Expand Down
2 changes: 1 addition & 1 deletion Regulus.Serialization/Regulus.Serialization.csproj
View file
Expand Up @@ -7,7 +7,7 @@

<PackageProjectUrl>https://github.com/jiowchern/Regulus.Remote</PackageProjectUrl>
<Authors>jc</Authors>

<Description>serialization lib.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
10 changes: 0 additions & 10 deletions Regulus.sln
View file
Expand Up @@ -63,9 +63,6 @@ EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regulus.Remote.Standalone.Test", "Regulus.Remote.Standalone.Test\Regulus.Remote.Standalone.Test.csproj", "{82BAA92B-B238-4F83-B836-9D81C335393F}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regulus.Projects.TestProtocol.Common", "Regulus.Projects.TestProtocol.Common\Regulus.Projects.TestProtocol.Common.csproj", "{FBA5C01D-B12F-4C15-9A1F-2178761DC268}"
ProjectSection(ProjectDependencies) = postProject
{E95CCE80-055C-4E8C-9351-BE92B29DDD68} = {E95CCE80-055C-4E8C-9351-BE92B29DDD68}
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regulus.Projects.TestProtocol.Protocol", "Regulus.Projects.TestProtocol.Protocol\Regulus.Projects.TestProtocol.Protocol.csproj", "{C212EC33-8497-470B-AE2B-C993FDF34129}"
EndProject
Expand All @@ -77,8 +74,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regulus.Utility", "RegulusU
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regulus.Utility.Test", "RegulusUtility\Regulus.Utility.Test\Regulus.Utility.Test.csproj", "{4C4332A4-962B-494F-882B-5E254CCD7C29}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Regulus.Remote.Tools.Protocol", "Regulus.Remote.Tools.Protocol\Regulus.Remote.Tools.Protocol.csproj", "{E95CCE80-055C-4E8C-9351-BE92B29DDD68}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -177,10 +172,6 @@ Global
{4C4332A4-962B-494F-882B-5E254CCD7C29}.Debug|Any CPU.Build.0 = Debug|Any CPU
{4C4332A4-962B-494F-882B-5E254CCD7C29}.Release|Any CPU.ActiveCfg = Release|Any CPU
{4C4332A4-962B-494F-882B-5E254CCD7C29}.Release|Any CPU.Build.0 = Release|Any CPU
{E95CCE80-055C-4E8C-9351-BE92B29DDD68}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{E95CCE80-055C-4E8C-9351-BE92B29DDD68}.Debug|Any CPU.Build.0 = Debug|Any CPU
{E95CCE80-055C-4E8C-9351-BE92B29DDD68}.Release|Any CPU.ActiveCfg = Release|Any CPU
{E95CCE80-055C-4E8C-9351-BE92B29DDD68}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -210,7 +201,6 @@ Global
{1A57D297-F056-4C80-94DD-267B30A871A3} = {A088BA49-DE34-4F59-AF19-C82A94D7F834}
{BBEA4BDD-AE30-4905-9EC8-398D14FC98C7} = {BF82B497-EC2D-4F8B-AF59-02AEC21A6B15}
{4C4332A4-962B-494F-882B-5E254CCD7C29} = {F37C2CFD-4962-4E1B-96EB-E5E8928D217B}
{E95CCE80-055C-4E8C-9351-BE92B29DDD68} = {A088BA49-DE34-4F59-AF19-C82A94D7F834}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {5F361C65-F7E7-4579-84BF-3D8DB0C9DABA}
Expand Down
2 changes: 1 addition & 1 deletion RegulusUtility
Submodule RegulusUtility updated 1 files
+1 −1 Regulus.Utility/Regulus.Utility.csproj

0 comments on commit 173ad46

Please sign in to comment.