Mercurial > hg > ucx / changeset

--- a/docs/Writerside/topics/install.md	Sun Feb 09 22:06:00 2025 +0100
+++ b/docs/Writerside/topics/install.md	Mon Feb 10 21:59:39 2025 +0100
@@ -11,8 +11,8 @@
 <tab title="Unix / Linux">
 <procedure>
 <step>
-Download the latest source archive from <a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a>
-and extract it somewhere on your machine.
+Download the latest source archive from
+<a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a> and extract it somewhere on your machine.
 You can also use the command line to do this. 
 <code-block lang="sh">
 wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz
@@ -37,8 +37,8 @@
 <tab title="Windows">
 <procedure>
 <step>
-Download the latest source archive from <a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a>
-and extract it somewhere on your machine.
+Download the latest source archive from
+<a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a> and extract it somewhere on your machine.
 </step>
 <step>
 Navigate to the folder named <code>msvc</code> in the extracted directory structure.
@@ -46,7 +46,14 @@
 <step>
 Open the contained <code>ucx.sln</code> in Visual Studio and build the solution.
 </step>
+<step>
+The libucx project in the solution will produce a libucx.lib that can be used for static linking
+and the libucx_dll project will produce a libucx.dll and a libucx.dll.lib import lib for dynamic linking.
+</step>
 </procedure>
+<note>
+For native Windows projects it is recommended to statically link UCX.
+</note>
 </tab>
 </tabs>
 
@@ -77,6 +84,21 @@
         </tip>
     </td>
 </tr>
+<tr>
+    <td>CX_WINDLL</td>
+    <td>
+        Define this macro during compilation of the project that is <emphasis>using</emphasis>
+        UCX as a Windows DLL to import the symbols.
+        In general it is recommended to use UCX as a static library under Windows, though.
+    </td>
+</tr>
+<tr>
+    <td>CX_WINDLL_EXPORT</td>
+    <td>
+        Define this macro during compilation of UCX to export symbols for a Windows DLL.
+        <tip>The Visual Studio Solution does that automatically.</tip>
+    </td>
+</tr>
 </table>
 
 ### Small Buffer Optimizations