splitting windows and linux docs: Readme links

This commit is contained in:
Fasjeit 2020-02-11 14:31:45 +03:00 коммит произвёл GitHub
Родитель 218f5e1a55
Коммит c6a3d6fa9a
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 2 добавлений и 188 удалений

190
README.md
Просмотреть файл

@ -1,192 +1,6 @@
# DotnetCoreSampleProject
Пример проекта Dotnet Core с реализацией ГОСТ криптографии.
## Сборка проекта без сборки corefx для Windows
[Инструкция для сборки под Windows](https://github.com/CryptoProLLC/DotnetCoreSampleProject/blob/master/docs/Windows.md)
Для сборки проекта необходимо выполнить следующие действия:
1. Установить КриптоПро CSP 5.0. Убедиться что введена действующая лицензия.
2. Установить последнюю версию [core 3.1 sdk и runtime](https://dotnet.microsoft.com/download) .
3. Задать переменную среды DOTNET_MULTILEVEL_LOOKUP=0.
4. Скачать архив [packages](https://ci.appveyor.com/project/CryptoProLLC/corefx/build/artifacts) и разархивировать его в папку packages по некоторому пути `packages_PATH`.
5. Скачать архив [runtime](https://ci.appveyor.com/project/CryptoProLLC/corefx/build/artifacts) и и разархивировать его в папку runtime по некоторому пути `runtime_PATH`.
6. Изменить файл `%appdata%\NuGet\NuGet.Config`, добавив в начало узла `packageSources` источник `<add key="local coreclr" value="packages_PATH\Debug\NonShipping" />`.
Пример:
```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="local coreclr" value="C:\packages\Debug\NonShipping" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
</packageSources>
</configuration>
```
7. Скопировать сборки NetStandard из репозитория [NetStandard.Library](https://github.com/CryptoProLLC/NetStandard.Library/tree/master/nugetReady/netstandard.library) в локальную директорию nuget (`$env:userprofile\.nuget\packages\`) с заменой.
Пример powershell скрипта, выполняющего данную операцию
```powershell
git clone https://github.com/CryptoProLLC/NetStandard.Library
New-Item -ItemType Directory -Force -Path "$env:userprofile\.nuget\packages\netstandard.library"
Copy-Item -Force -Recurse ".\NetStandard.Library\nugetReady\netstandard.library" -Destination "$env:userprofile\.nuget\packages\"
```
8. Выкачать локально репозиторий текущего проекта.
```powershell
git clone https://github.com/CryptoProLLC/DotnetCoreSampleProject
```
9. Изменить файл DotnetSampleProject.csproj, указав правильные пути до сборок `System.Security.Cryptography.Pkcs.dll` и `System.Security.Cryptography.Xml.dll`, указав в качестве пути
`runtime_PATH`.
Пример:
```xml
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp3.1</TargetFramework>
<RuntimeIdentifier>win-x64</RuntimeIdentifier>
<!-- make self-contained -->
<PackageConflictPreferredPackages>Microsoft.Private.CoreFx.NETCoreApp;runtime.win-x64.Microsoft.Private.CoreFx.NETCoreApp;runtime.linux-x64.Microsoft.Private.CoreFx.NETCoreApp;$(PackageConflictPreferredPackages)</PackageConflictPreferredPackages>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Private.CoreFx.NETCoreApp" Version="4.7.0-dev.20111.1" />
</ItemGroup>
<ItemGroup>
<Reference Include="System.Security.Cryptography.Pkcs">
<HintPath>C:\runtime\System.Security.Cryptography.Pkcs.dll</HintPath>
</Reference>
<Reference Include="System.Security.Cryptography.Xml">
<HintPath>C:\runtime\System.Security.Cryptography.Xml.dll</HintPath>
</Reference>
</ItemGroup>
</Project>
```
10. Перейти в папку проекта. Восстановить зависимости и собрать проект. Запустить полученный проект.
```powershell
cd DotnetCoreSampleProject
dotnet restore
dotnet build
dotnet run
```
## Сборка проекта со сборкой corefx для Windows
1. Выполнить шаги 1-3 из "Сборка проекта без сборки corefx".
2. Выкачать репозиторий [corefx](https://github.com/CryptoProLLC/corefx/).
3. Выполнить сборку corefx, перейдя в локальную папку репозитория и выполнив `build.cmd`.
4. Выполнить шаг 6 из "Сборка проекта без сборки corefx", использовав в качестве пути
`packages_PATH` путь вида `corefx_PATH\artifacts\packages`, где `corefx_PATH` путь до локальной папки репозитория corefx.
5. Выполнить шаги 7-10 из "Сборка проекта без сборки corefx", использовав в качестве пути
`packages_PATH` путь вида `corefx_PATH\artifacts\packages`, где `corefx_PATH` путь до локальной папки репозитория corefx.
В случае внесения изменений в репозиторий corefx, перед его сборкой необходимо очистить папки
`%userprofile%\.nuget\packages\microsoft.private.corefx.netcoreapp`, `%userprofile%\.nuget\packages\runtime.win-x64.microsoft.private.corefx.netcoreapp`, `corefx_PATH\artifacts\packages`
после чего завершить все процессы dotnet core.
Пример скрипта выполняющего данное действие
```powershell
taskkill /im dotnet.exe /f
rmdir /S /Q %userprofile%\.nuget\packages\microsoft.private.corefx.netcoreapp
rmdir /S /Q %userprofile%\.nuget\packages\runtime.win-x64.microsoft.private.corefx.netcoreapp
rmdir /S /Q artifacts\packages
build
```
## Сборка проекта без сборки corefx для Linux
Для сборки проекта необходимо выполнить следующие действия:
1. Установить КриптоПро CSP 5.0. Убедиться что введена действующая лицензия.
2. Установить последнюю версию [core 3.1 sdk и runtime](https://dotnet.microsoft.com/download).
3. Задать переменную среды DOTNET_MULTILEVEL_LOOKUP=0.
4. Скачать архив [packages](https://ci.appveyor.com/project/CryptoProLLC/corefx/build/artifacts) и разархивировать его в папку packages по некоторому пути `packages_PATH`.
5. Скачать архив [runtime](https://ci.appveyor.com/project/CryptoProLLC/corefx/build/artifacts) и и разархивировать его в папку runtime по некоторому пути `runtime_PATH`.
6. Изменить файл `~/.nuget/NuGet/NuGet.Config`, добавив в начало узла `packageSources` источник `<add key="local coreclr" value="packages_PATH/Debug/NonShipping" />`.
Пример:
```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="local coreclr" value="~/git/packages/Debug/NonShipping" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
</packageSources>
</configuration>
```
7. Скопировать сборки NetStandard из репозитория [NetStandard.Library](https://github.com/CryptoProLLC/NetStandard.Library/tree/master/nugetReady/netstandard.library) в локальную директорию nuget (`~.nuget/packages/`) с заменой.
Пример sh скрипта, выполняющего данную операцию
```sh
git clone https://github.com/CryptoProLLC/NetStandard.Library
mkdir -p ~/.nuget/packages/netstandard.library
cp -r ./NetStandard.Library/nugetReady/netstandard.library ~/.nuget/packages/
```
8. Выкачать локально репозиторий текущего проекта.
```sh
git clone https://github.com/CryptoProLLC/DotnetCoreSampleProject
```
9. Изменить файл DotnetSampleProject.csproj, указав правильные пути до сборок `System.Security.Cryptography.Pkcs.dll` и `System.Security.Cryptography.Xml.dll`, указав в качестве пути
`runtime_PATH`. Изменить `RuntimeIdentifier` на `linux-x64`
Пример:
```xml
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp3.1</TargetFramework>
<RuntimeIdentifier>linux-x64</RuntimeIdentifier>
<!-- make self-contained -->
<PackageConflictPreferredPackages>Microsoft.Private.CoreFx.NETCoreApp;runtime.win-x64.Microsoft.Private.CoreFx.NETCoreApp;runtime.linux-x64.Microsoft.Private.CoreFx.NETCoreApp;$(PackageConflictPreferredPackages)</PackageConflictPreferredPackages>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Private.CoreFx.NETCoreApp" Version="4.7.0-dev.20111.1" />
</ItemGroup>
<ItemGroup>
<Reference Include="System.Security.Cryptography.Pkcs">
<HintPath>../runtime/netcoreapp-Linux-Debug-x64/System.Security.Cryptography.Pkcs.dll</HintPath>
</Reference>
<Reference Include="System.Security.Cryptography.Xml">
<HintPath>../runtime/netcoreapp-Linux-Debug-x64/System.Security.Cryptography.Xml.dll</HintPath>
</Reference>
</ItemGroup>
</Project>
```
10. Перейти в папку проекта. Восстановить зависимости и собрать проект. Запустить полученный проект.
```sh
cd DotnetCoreSampleProject
dotnet restore
dotnet build
dotnet run
```
Дополнительную информацию можно получить тут:
- https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/dogfooding.md
- https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/developer-guide.md
- https://github.com/dotnet/corefx/blob/master/Documentation/building/windows-instructions.md
[Инструкиц для сборки под Linux](https://github.com/CryptoProLLC/DotnetCoreSampleProject/blob/master/docs/Linux.md)