diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index eb01658..9ba6e86 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: "[FEAT] ____" -labels: enhancement +labels: new assignees: raub --- diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e0b46dc..1d0e019 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,7 +47,7 @@ jobs: name: Build strategy: matrix: - os: [ubuntu-20.04, windows-2022, macos-12, macos-14, [self-hosted, linux, ARM64]] + os: [ubuntu-20.04, windows-2022, macos-14, [self-hosted, linux, ARM64]] runs-on: ${{ matrix.os }} diff --git a/README.md b/README.md index df45fb1..7f3e62c 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,11 @@ This is a part of [Node3D](https://github.com/node-3d) project. npm i -s segfault-raub ``` -This module installs platform-specific **signal** listeners -(see `sigaction` for **Unix** and `SetUnhandledExceptionFilter` for **Windows**). -Whenever a signal is raised, the module prints a native stack trace (if possible) to both -**STDERR** and to the "**segfault.log**" file (if it exists inside "working directory"). +This module report debug information on process crash (and some other events). +It doesn't affect the performance while the program is running normally. + +The module prints to both +**STDERR** and to the **"segfault.log"** file (if it exists inside **"working directory"**). If there is no such file, it **won't be created**, so it is up to you if the log-file is needed. @@ -34,12 +35,14 @@ and **WILL NOT** import their own **binaries**. --- -If you want to use a custom location instead of "**segfault.log**", use +If you want to use a custom location instead of "**segfault.log**", use: ```js require('segfault-raub').setLogPath("C:/my/log/file.txt"); ``` +**You must create this file first, it must be there when the crash happens.** + See the [TypeScript declarations](/index.d.ts) with comments. diff --git a/package.json b/package.json index 7362601..3f16bc2 100644 --- a/package.json +++ b/package.json @@ -23,8 +23,7 @@ "install.js", "LICENSE", "LICENSE_node-segfault-handler", - "package.json", - "README.md" + "package.json" ], "scripts": { "postinstall": "node install",