From 2823b48bcb3e151c73278438c802e3f1ddc5a100 Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Mon, 5 Aug 2024 17:06:30 +0300 Subject: [PATCH] website: re-generate commons --- website/docs/install/index.mdx | 46 ++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx index 70f40af..0d0854b 100644 --- a/website/docs/install/index.mdx +++ b/website/docs/install/index.mdx @@ -196,6 +196,18 @@ cd my-project xpm init ``` +
+Under the hood + +The main purpose of `xpm init` is to create a `package.json` file, if not +already present. + +In addition to `name` & `version`, the minimal `package.json` must +include a property named `xpacks`, even empty. This property is +mandatory to identify the package as an **xPack**. + +
+ ### Install into the project The next step is to install the @@ -447,6 +459,40 @@ To completely remove the package from the central xPack store: `xpm uninstall --global @xpack-dev-tools/riscv-none-elf-gcc --verbose` } +
+Clean-ups + +For a thorough clean-up, please note that **xpm** uses only two folders: + + + + +- `%APPDATA%\Roaming\xPacks` +- `%APPDATA%\Local\Caches\xPacks` + + + + +- `${HOME}/Library/xPacks` +- `${HOME}/Library/Caches/xPacks` + + + + +- `${HOME}/.local/xPacks` +- `${HOME}/.cache/xPacks` + + + + +They can be removed at any time and space reclaimed; +**xpm** will recreate them on new installs. + +However, projects linking to the central xPack store will fail with +broken paths. + +
+ ## Manual install