Skip to content

Commit 774444c

Browse files
author
Nicolas PAVIE
committed
chore: updated readme
1 parent 2519dfe commit 774444c

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,43 @@ The code available in this GitHub project has been initially copied from its ori
77

88
## Building requirement
99

10-
The project is being updated to build with visual studio 2019, using the dotnet4 plugin and the wix toolser in its version 3.11.
10+
The project is being updated to build with visual studio 2026.
11+
12+
The MSI packages are build using a wix toolset project, and requires [Wix toolset version 6](https://github.com/wixtoolset/wix/releases/tag/v6.0.2) to be installed.
13+
14+
To ease the building of releases, a `build.ps1` powershell script is provided (tested with powershell 7+).
15+
This scripts requires to have the MSBuild tools directory registered in your PATH variable
16+
(if you use visual studio 2026, you can add the entry `%PROGRAMFILES%\Microsoft Visual Studio\18\Community\MSBuild\Current\Bin` to you path)
17+
18+
## Build the current release
19+
20+
Just launch `build.ps1` and it should launch the packaging process.
21+
The final installer should be then found in the `Installer\SaveAsDAISYInstaller\bin\Release` on success
22+
23+
You can update the version of the release package by using the flag `-version` followed by the new version code (in format \d+.\d+.\d+.\d+)
24+
For example `build.ps1 -version 2.9.4.2`
25+
26+
## Updating the embedded engine
27+
28+
The embedded daisy pipeline version for SaveAsDAISY can be found here : https://github.com/NPavie/pipeline/tree/save-as-daisy
29+
Just clone the repo somewhere, install the requirements (java8 JDK and maven) and use the following command from the pipeline repository root folder
30+
`.\assembly\make.exe FIXED_BUILD=true dist-zip-sad`
31+
32+
After replacing the `resources\daisy-pipeline` it is recommended to do a quick debug build of the `Common\JNIWrapper` project, to get the updated pipeline properties descriptor file and ensure it works.
33+
34+
You can then use the command `build.ps1 -refreshPipeline -nobuild` to update the wix project (but without triggering the whole build with the `-nobuild` flag to gain some time)
35+
36+
## Debugging the addin
37+
38+
If you need to debug the addin, you need to first install the last beta release available.
39+
After that you can just close Microsoft word if it is open and launch `build.ps1 -debug` to build the addin in debug mode.
40+
The command will then open word, and you can debug it by attaching Visual studio to the word instance.
41+
42+
Note that the debug command will also redeploy the embedded pipeline in the addin install repository.
1143

1244
## Notes
1345

1446
In case of multiple crash of the addin, it might be registered in Word's addin blocklist.
1547
`HKEY_CURRENT_USER\Software\Microsoft\Office\16.0\Word\Resiliency\DisabledItem`
1648

49+

0 commit comments

Comments
 (0)