Update C++ unicode docs

velopack · Mar 10, 2024 · 0967eb5 · 0967eb5
1 parent 5a62780
commit 0967eb5
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 22 deletions.
diff --git a/docs/getting-started/cpp.mdx b/docs/getting-started/cpp.mdx
@@ -4,17 +4,34 @@ Get started with our cross-platform C++ header library.
 
 1. Copy [Velopack.hpp](https://github.com/velopack/velopack.fusion/blob/master/for-cpp/Velopack.hpp) and [Velopack.cpp](https://github.com/velopack/velopack.fusion/blob/master/for-cpp/Velopack.cpp) into your project. 
 
-0. If you are on Linux or MacOS, you'll need [ICU4C](https://icu.unicode.org/) installed. Like many other C libraries, 
-installing the development package with your package manager (`apt`, `brew` etc) should be sufficient to make it available to compilers. 
-The specific command you'll need is OS/Distro specific.
+0. Configure Unicode Support:
+    #### Windows
+    On Windows, to enable unicode support for this library you ***must*** 
+    [configure the UTF-8 code page](https://learn.microsoft.com/en-us/windows/apps/design/globalizing/use-utf8-code-page) via your application 
+    manifest. Failure to do so will potentially result in your application ***failing to update*** if there are any unicode characters in your user's 
+    file paths, username, etc.
+    ```xml
+    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <assembly manifestVersion="1.0" xmlns="urn:schemas-microsoft-com:asm.v1">
+      <application>
+        <windowsSettings>
+          <activeCodePage xmlns="http://schemas.microsoft.com/SMI/2019/WindowsSettings">UTF-8</activeCodePage>
+        </windowsSettings>
+      </application>
+    </assembly>
+    ```
+    #### Linux & MacOS
+    - If you are using Qt and `QString` is available, there's nothing further you need to do. 
+    - If you are not using Qt, you'll need to [install ICU4C](https://icu.unicode.org/). Like many other C libraries, 
+      installing the development package with your package manager (`apt`, `brew` etc) *should* be sufficient to make it available to compilers.
 
 0. Add the `Velopack::startup()` to your entry point (eg. `main()` or `wmain()`) as early as possible, ideally the first statement to run:
     ```cpp
     #include "Velopack.hpp"
 
     wmain(int argc**, wchar_t *argv[ ], wchar_t *envp[ ])
     {
-        // velopack may exit / restart your app at this statement
+        // Velopack may exit / restart your app at this statement
         Velopack::startup(argv, argc);
 
         // ... your other startup code here
@@ -31,7 +48,7 @@ The specific command you'll need is OS/Distro specific.
         Velopack::UpdateManagerSync manager{};
         manager.setUrlOrPath("https://the.place/you-host/updates");
 
-        std::shared_ptr<Velopack::UpdateInfo> updInfo = manager.checkForUpdates();
+        auto updInfo = manager.checkForUpdates();
         if (updInfo == nullptr) {
             return; // no updates available
         }
@@ -41,23 +58,6 @@ The specific command you'll need is OS/Distro specific.
     }
     ```
 
-0. Enable the [UTF-8 codepage](https://learn.microsoft.com/en-us/windows/apps/design/globalizing/use-utf8-code-page) in your application manifest if you are targeting Windows.
-    ```xml
-    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-    <assembly manifestVersion="1.0" xmlns="urn:schemas-microsoft-com:asm.v1">
-      <application>
-        <windowsSettings>
-          <activeCodePage xmlns="http://schemas.microsoft.com/SMI/2019/WindowsSettings">UTF-8</activeCodePage>
-        </windowsSettings>
-      </application>
-    </assembly>
-    ```
-    :::warning[Enabling Unicode Support]
-    The Velopack C++ Library expects UTF-8 `std::string` and `char*` strings, which is standard practice on Unix-like operating systems, so no extra steps are needed there.
-    On Windows, Velopack will use the `A` (ansi) windows functions which accept `char*` rather than the `W` (UTF-16) unicode functions.
-    By adding the UTF-8 code page to your application manifest, the `A` ansi functions will switch to accepting UTF-8.
-    :::
-
 0. Install the `vpk` command line tool:
     ```sh
     dotnet tool update -g vpk

diff --git a/src/css/custom.css b/src/css/custom.css
@@ -36,6 +36,10 @@
   --ifm-navbar-search-input-icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='20' height='20' class='DocSearch-Search-Icon' viewBox='0 0 20 20'%3E%3Cpath d='M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z' stroke='white' fill='none' fill-rule='evenodd' stroke-linecap='round' stroke-linejoin='round'%3E%3C/path%3E%3C/svg%3E");
 }
 
+h4 {
+  text-decoration: underline;
+}
+
 .navbar__search-input {
   border: 1px solid #DADDE1;
   height: 40px;