-
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): add instructions for choosing the correct pkg cache fol…
…der (#8) * docs(README): add instructions for choosing the correct pkg cache folder see https://github.com/vercel/pkg-fetch/blob/03f551cd538d9cd631c70215c5c7b2f85965411c/lib/places.js#L12-L16 on how the cache identifier is built * Update README.md
- Loading branch information
Showing
1 changed file
with
19 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,22 +10,37 @@ Collection of NodeJS precompiled binaries to use with [pkg][207006e9]. Please su | |
|
||
## Usage | ||
|
||
Just download the desired binary and copy it into `.pkg-cache` folder or (if present) to any subfolders inside that (depends on your version of `pkg`, in my case I have to copy it inside `~/.pkg-cache/v2.5`). After this run your `pkg` command and now it will find the desired binary in cache. | ||
Just download the desired binary and copy it into the correct `.pkg-cache/vMAJOR.MINOR` version subfolder. After this run your `pkg` command and now it will find the desired binary in cache. | ||
|
||
Example with `arm64` `node v8.11.3` `linux`: | ||
|
||
```bash | ||
# Must set -O to preserve the correct file metadata | ||
wget https://github.com/robertsLando/pkg-binaries/releases/download/v1.0.0/fetched-v14.0.0-linux-armv6 -O fetched-v8.11.3-linux-arm64 | ||
sudo mv fetched-v8.11.3-linux-arm64 ~/.pkg-cache/ | ||
sudo mv fetched-v8.11.3-linux-arm64 ~/.pkg-cache/v2.6 | ||
``` | ||
|
||
**Note:** Finding the correct `.pkg-cache/vMAJOR.MINOR` folder | ||
|
||
The naming of the cache folder is dependent on the version of `pkg-fetch` that is installed. Usually the naming convention is `vMAJOR.MINOR`. You can easily find out which version is installed by running `npm ls pkg-fetch` (or `yarn why pkg-fetch` for yarn users). | ||
|
||
It will print something like the following to the terminal: | ||
|
||
```` | ||
some@space:~/project$ npm ls pkg-fetch | ||
[email protected] /Users/laurin/project | ||
└─┬ [email protected] | ||
└── [email protected] | ||
```` | ||
|
||
According to the output you must download the binary into `~/.pkg-cache/v2.6`. | ||
|
||
> **ATTENTION** | ||
Once you have placed the file in `.pkg-cache` folder check that the output of `file` command gives you the correct interpreter: | ||
|
||
```bash | ||
pi@NanoPi-NEO-Plus2:~/.pkg-cache/v2.5$ file fetched-v8.11.3-linux-arm64 | ||
pi@NanoPi-NEO-Plus2:~/.pkg-cache/v2.6$ file fetched-v8.11.3-linux-arm64 | ||
fetched-v8.11.3-linux-arm64: ELF 64-bit LSB shared object, ARM aarch64, version 1 (GNU/Linux), dynamically linked, interpreter /lib/ld-, for GNU/Linux 3.7.0, BuildID[sha1]=02bf3444ecc520c4da40e89cbfbf6831e3a205ea, not stripped | ||
``` | ||
|
||
|
@@ -110,7 +125,7 @@ Usually pkg automatically compiles this binary if it doesn't find them in his re | |
|
||
5. Finally copy the binary: | ||
|
||
`cp node ~/.pkg-cache/v2.5/fetched-v8.11.3-linux-arm64` | ||
`cp node ~/.pkg-cache/v2.6/fetched-v8.11.3-linux-arm64` | ||
|
||
[207006e9]: https://github.com/zeit/pkg "Zeit Pkg" | ||
|
||
|