docs: update readme

This commit is contained in:
calebboyd
2021-09-26 17:15:06 -05:00
parent 805ca35149
commit e539093ef4
+14 -21
View File
@@ -9,7 +9,7 @@
<a href="https://discord.gg/2qTH52zNcZ"><img src="https://discordapp.com/api/guilds/814334925049561168/widget.png?style=shield"></a>
</p>
<p align="center"><code>npm i nexe -g</code></p>
<p align="center">Install:&nbsp<code>npm i nexe -g</code></p>
<p align="center">Nexe is a command-line utility that compiles your Node.js application into a single executable file.</p>
<p align="center">
@@ -27,11 +27,6 @@
- Flexible build pipeline
- Cross platform builds
## Installing
`npm install nexe -g`
If using Windows, after you run the command above, close out of your console session then open a new console (cmd/powershell/pwsh).
## Usage
- Application entrypoint:
@@ -54,21 +49,6 @@ For more CLI options see: `nexe --help`
Additional files or resources can be added to the binary by passing `-r "glob/pattern/**/*"`. These included files can be read in the application by using `fs.readFile` or `fs.readFileSync`.
## Troubleshooting
`Error: Entry file "" not found!` means you need to provide `nexe` with input. Either use `-i` or pipe data to it.
`Error: https://github.com/nexe/nexe/releases/download/v3.3.3/windows-x64-15.8.0 is not available, create it using the --build flag` or similar message means that it either:
- You are having networking issues such as the download being blocked
- You just to specify the target so `nexe` knows what version of the executable to use.
- See the [releases page](https://github.com/nexe/nexe/releases) to find the executable's version number
- At the time of writing this, the latest binary build version is `14.5.3` from release version `3.3.3`.
- You can replace this with another version from the Releases page if desired.
- Example
- `nexe -i "app.js" -r "public/**/*.html" -o "dist/myApp.exe" -t x64-14.15.3`
- Where `-i` specifies the input, `-r` specifies resources to embed, `-o` specifies the output, `-t` specifies the target.
- Alternatively you can compile the executable yourself, see that section for details
## Compiling the nexe Executable
By default `nexe` will attempt to download a pre-built executable. These are listed on the [releases page](https://github.com/nexe/nexe/releases/tag/v3.3.3). The exact version you want may be unavailable or you may want to customize what is built. See `nexe --help` for a list of options available when passing the [`--build`](#build-boolean) option. You will also need to ensure your environment is setup to [build node](https://github.com/nodejs/node/blob/master/BUILDING.md). Note: the `python` binary in your path should be an acceptable version of python 2. eg. Systems that have python 2 will need to create a [symlink](https://github.com/nexe/nexe/issues/354#issuecomment-319874486).
@@ -272,6 +252,19 @@ Any modifications made to `NexeFile#contents` will be maintained in the cache _w
In order to use native modules, the native binaries must be shipped alongside the binary generated by nexe.
## Troubleshooting
`Error: Entry file "" not found!` means you need to provide `nexe` with input. Either use `-i` or pipe data to it.
`Error: https://github.com/nexe/nexe/releases/download/v3.3.3/windows-x64-15.8.0 is not available, create it using the --build flag` or similar message means that it either:
- You are having networking issues such as the download being blocked
- You should specify the target so `nexe` knows what version of the executable to use.
- See the [releases page](https://github.com/nexe/nexe/releases) to find the executable's version number
- Example
- `nexe -i "app.js" -r "public/**/*.html" -o "dist/myApp.exe" -t x64-14.15.3`
- where `-i` specifies the input, `-r` specifies resources to embed, `-o` specifies the output, `-t` specifies the target.
- Alternatively you can compile the executable yourself, see that section for details
## Contributing
Building