summaryrefslogtreecommitdiff
path: root/node_modules/rcedit/README.md
diff options
context:
space:
mode:
authorLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
committerLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
commit703e03aba33f234712206769f57717ba7d92d23d (patch)
tree0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/rcedit/README.md
parentab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff)
downloadFlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz
FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/rcedit/README.md')
-rw-r--r--node_modules/rcedit/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/node_modules/rcedit/README.md b/node_modules/rcedit/README.md
new file mode 100644
index 0000000..eee2ce7
--- /dev/null
+++ b/node_modules/rcedit/README.md
@@ -0,0 +1,43 @@
+# node-rcedit
+
+[![CircleCI build status](https://circleci.com/gh/electron/node-rcedit/tree/master.svg?style=svg)](https://circleci.com/gh/electron/node-rcedit/tree/master)
+
+Node module to edit resources of Windows executables.
+
+## Requirements
+
+On platforms other than Windows, you will need to have [Wine](https://winehq.org)
+1.6 or later installed and in the system path.
+
+## Usage
+
+```javascript
+const rcedit = require('rcedit')
+```
+
+### `async rcedit(exePath, options)`
+
+`exePath` is the path to the Windows executable to be modified.
+
+`options` is an object that can contain following fields:
+
+* `version-string` - An object containing properties to change the `exePath`'s
+ version string.
+* `file-version` - File's version to change to.
+* `product-version` - Product's version to change to.
+* `icon` - Path to the icon file (`.ico`) to set as the `exePath`'s default icon.
+* `requested-execution-level` - Requested execution level to change to, must be
+ either `asInvoker`, `highestAvailable`, or `requireAdministrator`. See
+ [here](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) for
+ more details.
+* `application-manifest` - String path to a local manifest file to use.
+ See [here](https://msdn.microsoft.com/en-us/library/windows/desktop/aa374191.aspx)
+ for more details.
+
+Returns a `Promise` with no value.
+
+## Building
+
+* Clone the repository
+* Run `npm install`
+* Run `npm test` to run the tests