|
| 1 | +{/* DO NOT EDIT! */} |
| 2 | +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} |
| 3 | + |
| 4 | +{/* ------------------------------------------------------------------------ */} |
| 5 | + |
| 6 | +### Prerequisites |
| 7 | + |
| 8 | +The only requirement for an automated installation is a recent |
| 9 | +[xpm](https://xpack.github.io/xpm/), which is a portable |
| 10 | +[Node.js](https://nodejs.org) command line application |
| 11 | +that complements [npm](https://docs.npmjs.com) |
| 12 | +with several additional features specific to |
| 13 | +**C/C++ projects**. |
| 14 | + |
| 15 | +To install **xpm**, |
| 16 | +follow the instructions on the |
| 17 | +[xpm install](https://xpack.github.io/xpm/install/) page. |
| 18 | + |
| 19 | +If already installed, it is always advisable to update it to the |
| 20 | +latest version with: |
| 21 | + |
| 22 | +```sh |
| 23 | +npm install --location=global xpm@latest |
| 24 | +``` |
| 25 | + |
| 26 | +:::tip |
| 27 | + |
| 28 | +Although not mandated by **xpm**, it is also advisable to upgrade |
| 29 | +**npm** to the latest version, and |
| 30 | +**node** to a reasonably recent version (currently **npm** requires |
| 31 | +a **node** >=18.17.0). |
| 32 | + |
| 33 | +::: |
| 34 | + |
| 35 | +<details> |
| 36 | +<summary>Local installations</summary> |
| 37 | + |
| 38 | +One of the xPack design goals is to allow each project to |
| 39 | +select the exact versions of the libraries it requires. |
| 40 | + |
| 41 | +Similarly to **npm** being able to install specific versions of the |
| 42 | +JavaScript tools into each project, |
| 43 | +**xpm** was also designed to be able to install specific versions of the |
| 44 | +required libraries locally into each project. |
| 45 | + |
| 46 | +Therefore, similarly to the way **npm** installs the JavaScript packages into |
| 47 | +`node_modules`, **xpm** installs the libraries into |
| 48 | +`xpacks`. Here there will be separate folders with the installed |
| 49 | +packages, for example |
| 50 | +<code>xpacks/xpack-build-box</code>. |
| 51 | + |
| 52 | +</details> |
0 commit comments