[njs] Improved README.md clarity with angle bracket explanations.
noreply at nginx.com
noreply at nginx.com
Wed Jun 4 16:03:02 UTC 2025
details: https://github.com/nginx/njs/commit/5b791257e499fc5e76181121011415086735c094
branches: master
commit: 5b791257e499fc5e76181121011415086735c094
user: Dmitry Volyntsev <xeioex at nginx.com>
date: Tue, 3 Jun 2025 22:37:32 -0700
description:
Improved README.md clarity with angle bracket explanations.
---
README.md | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 10ef0ba7..f81075ce 100644
--- a/README.md
+++ b/README.md
@@ -310,20 +310,30 @@ https://github.com/nginx/nginx.git
## Building NGINX JavaScript as a module of NGINX
To build NGINX JavaScript as a dynamic module, execute the following commands from the NGINX source code repository's root directory:
+> [!NOTE]
+> Replace `<NJS_SRC_ROOT_DIR>` with the actual path to your NJS source directory.
+
```bash
auto/configure --add-dynamic-module=<NJS_SRC_ROOT_DIR>/nginx
```
To build with [QuickJS](https://nginx.org/en/docs/njs/engine.html) support, provide include and library path using `--with-cc-opt=` and `--with-ld-opt=` options:
+
+> [!NOTE]
+> Replace `<NJS_SRC_ROOT_DIR>` with the actual path to your NJS source directory and `<QUICKJS_SRC_ROOT_DIR>` with the actual path to your QuickJS source directory.
+
```bash
auto/configure --add-dynamic-module=<NJS_SRC_ROOT_DIR>/nginx \
- --with-cc-opt="-I<QUICKJS_SRC_ROOT_DIR>" --with-ld-opt="-L<QUICKJS_SRC_ROOT_DIR>"
+ --with-cc-opt="-I<QUICKJS_SRC_ROOT_DIR>" \
+ --with-ld-opt="-L<QUICKJS_SRC_ROOT_DIR>"
```
> [!WARNING]
> By default, this method will only build the `ngx_http_js_module` module. To use NJS with the NGINX Stream module, you'll need to enable it during the `configure` step so it builds with the NGINX binary. Doing so will automatically compile the `ngx_stream_js_module` module when NJS is added to the build. One way of accomplishing this is to alter the `configure` step to:
+>
> ```bash
-> auto/configure --with-stream --add-dynamic-module=<NJS_SRC_ROOT_DIR>/nginx
+> auto/configure --with-stream \
+> --add-dynamic-module=<NJS_SRC_ROOT_DIR>/nginx
> ```
Compile the module
More information about the nginx-devel
mailing list