Skip to content

Commit 9cab4b2

Browse files
committed
docs: add Windows installation guide
Starting from bson v4.6.0, the C extension is bundled directly into the gem, which requires a C compiler for installation. This causes installation failures on Windows environments by default. This commit updates the README to include instructions for Windows users to install the MSYS2 development toolchain via `ridk install` and run the gem installation using `ridk exec` to ensure native extensions build successfully. Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
1 parent 8c2640b commit 9cab4b2

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.rdoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,17 @@ The gem is hosted at {Rubygems.org}[http://rubygems.org]. You can install the ge
1717

1818
$ fluent-gem install fluent-plugin-mongo
1919

20+
=== For Windows users
21+
22+
This plugin depends on the C extension library (such as `bson` gem) which requires a C compiler to install.
23+
24+
If you are using Windows, you must install the {MSYS2}[https://www.msys2.org/] development toolchain before installing this plugin:
25+
26+
1. Run the following command in your command prompt:
27+
$ ridk install
28+
2. Select option `3` (MSYS2 and MINGW development toolchain).
29+
3. Once the compiler installation is complete, run the `ridk exec fluent-gem install fluent-plugin-mongo` command.
30+
2031
= Plugins
2132

2233
== Output plugin

0 commit comments

Comments
 (0)