From 0e6ea494754f95c90410b3c941ec2b4c59b9f36f Mon Sep 17 00:00:00 2001 From: Banbrytande Date: Thu, 6 Apr 2023 12:02:21 -0700 Subject: [PATCH] Updated build documentation --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index 321f5c4..ee6fa55 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,45 @@ ## Building +#### SDK Versions + +- .NET Standard Core 2.1 +- .NET Framework 4.6 or higher + +**Note:** Tested with Visual Studio 2019 with .NET 5.0 + +First, [pahkat](https://github.com/divvun/pahkat) needs to be built to your local directory. + +`git clone https://github.com/divvun/pahkat.git` + +**Important:** Divvun Manager does not talk to the language index itself. It only communicate locally running pahkat service. Pahkat is responsible to install and update languages. So, pahkat service should be up and running in your Windows's Services. + +Open `pahkat-client-core` directory in a terminal and source env for the platform `$Env:CARGO_FEATURE_WINDOWS="true"` before `cargo build`. Make sure the build to succeed. + +Second, you should clone the divvun manager repo in the same pahkat folder. + +`git clone https://github.com/divvun/divvun-manager-windows.git` + +Be sure `divvun-manager-windows` and `pahkat-client-core` share the same root directory. + +Open `Divvun.Installer.sln` in Visual Studio 2019 and build only `Pahkat.Sdk` project from the solution explorer to generate `Pahkat.Sdk.dll` file before building the whole solution. + +Finally, **Build > Build Solution (Ctrl-Shift-B)** + +When you try to run `Divvun.Installer`, it's not going to work because some pseudolocales will need to be added to your registry. The simplest way to do this is to install [kbdi](https://github.com/divvun/kbdi) outside of pahkat directory. + +`git clone https://github.com/divvun/kbdi.git` then `cargo build --release --target i686-pc-windows-msvc --bin kbdi` + +After the build is succeeded. Come to `.\target\i686-pc-windows-msvc\release` and run `kbdi.exe language_enable nn-Runr` command. + +If everything goes well, you can run `Divvun.Installer` and it should work just fine. + +#### Troubleshot + +You might end up with enabling old .Net SDKs in Windows Feature Panel. + +### Old guide + Open in Visual Studio 2017, run build in Release. In order for all supported locales to generate properly, some pseudolocales