chromium: add readme file

[kikadf (via pkgsrc-wip) <commit-notify%pkgsrc.org@localhost>]

Module Name:	pkgsrc-wip
Committed By:	kikadf <kikadf.01%gmail.com@localhost>
Pushed By:	kikadf
Date:		Tue May 13 18:12:11 2025 +0200
Changeset:	6104581e03ec3f01b488dbca8da38e6ca598dc20

Modified Files:
	chromium/Makefile
Added Files:
	chromium/files/README

Log Message:
chromium: add readme file

To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=6104581e03ec3f01b488dbca8da38e6ca598dc20

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

diffstat:
 chromium/Makefile     |  6 ++++--
 chromium/files/README | 29 +++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 2 deletions(-)

diffs:
diff --git a/chromium/Makefile b/chromium/Makefile
index c23e523db3..6297071495 100644
--- a/chromium/Makefile
+++ b/chromium/Makefile
@@ -162,7 +162,7 @@ GN_ARGS+=	use_sysroot=false
 GN_ARGS+=	use_system_freetype=true
 GN_ARGS+=	use_system_harfbuzz=true
 GN_ARGS+=	use_system_libdrm=true
-#GN_ARGS+=	use_system_libjpeg=true #libjpeg-turbo
+GN_ARGS+=	use_system_libjpeg=true #libjpeg-turbo
 GN_ARGS+=	use_thin_lto=false
 GN_ARGS+=	use_udev=false
 GN_ARGS+=	use_vaapi=false
@@ -270,7 +270,8 @@ BUILDDIR=		${WRKSRC}/out/${BUILDTYPE}
 INSTALLATION_DIRS+=	lib/${CHROMIUM}
 INSTALLATION_DIRS+=	bin
 INSTALLATION_DIRS+=	${PKGMANDIR}/man1
-INSTALLATION_DIRS+=	${PREFIX}/share/applications
+INSTALLATION_DIRS+=	share/applications
+INSTALLATION_DIRS+=	share/doc/${CHROMIUM}
 
 ICON_SIZES=		22_mono 24 48 64 128 256
 .for i in ${ICON_SIZES}
@@ -289,6 +290,7 @@ CHROMIUM_LIBS+=		vk_swiftshader_icd.json
 do-install:
 	${INSTALL_SCRIPT} ${WRKSRC}/${CHROMIUM}.sh ${DESTDIR}${PREFIX}/bin/${CHROMIUM}
 	${INSTALL_DATA} ${FILESDIR}/chromium-browser.desktop ${DESTDIR}${PREFIX}/share/applications
+	${INSTALL_DATA} ${FILESDIR}/README ${DESTDIR}${PREFIX}/share/doc/${CHROMIUM}
 	${INSTALL_PROGRAM} ${BUILDDIR}/chrome ${DESTDIR}${PREFIX}/lib/${CHROMIUM}
 	${INSTALL_PROGRAM} ${BUILDDIR}/chromedriver.unstripped  ${DESTDIR}${PREFIX}/bin/chromedriver
 .for i in ${CHROMIUM_LIBS}
diff --git a/chromium/files/README b/chromium/files/README
new file mode 100644
index 0000000000..ba1ee55749
--- /dev/null
+++ b/chromium/files/README
@@ -0,0 +1,29 @@
+$NetBSD: $
+
+Some notes on chromium:
+
+1) Wrapper flags support
+  The startup wrapper can read chromium flags
+  from ~/.config/chromium-flags.conf.
+  Example settings in chromium-flags.conf:
+    CHROMIUM_FLAGS="--disable-gpu"
+    CHROMIUM_FLAGS+=" --enable-logging=stderr --v=1"
+
+2) Disabling WebAssembly
+  WebAssembly is enabled by default, but it can be disabled by either:
+  - Setting CHROMIUM_ENABLE_WASM=0 in your environment, or
+  - Adding the following flags to ~/.config/chromium-flags.conf:
+    --disable-features=WebAssembly,AsmJsToWebAssembly,WebAssemblyStreaming
+    --js-flags=--noexpose-wasm
+
+3) Tab hang workaround
+  If you experience tab hanging issues (e.g.,
+  https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=212812),
+  increase the net.local.stream.recvspace value:
+    sysctl -w net.local.stream.recvspace=16384
+
+  To make it permanent, add this line to /etc/sysctl.conf:
+    net.local.stream.recvspace=16384
+
+4) HID support
+  HID is not yet supported on NetBSD, so FIDO devices do not work.