Skip to content

Commit

Permalink
website: re-generate commons
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Aug 5, 2024
1 parent ef3e8e0 commit 2823b48
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions website/docs/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,18 @@ cd my-project
xpm init
```

<details>
<summary>Under the hood</summary>

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**.

</details>

### Install into the project

The next step is to install the
Expand Down Expand Up @@ -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`
} </CodeBlock>

<details>
<summary>Clean-ups</summary>

For a thorough clean-up, please note that **xpm** uses only two folders:

<Tabs groupId="operating-systems">
<TabItem value="windows" label="Windows" default>

- `%APPDATA%\Roaming\xPacks`
- `%APPDATA%\Local\Caches\xPacks`

</TabItem>
<TabItem value="macos" label="macOS">

- `${HOME}/Library/xPacks`
- `${HOME}/Library/Caches/xPacks`

</TabItem>
<TabItem value="linux" label="GNU/Linux">

- `${HOME}/.local/xPacks`
- `${HOME}/.cache/xPacks`

</TabItem>
</Tabs>

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.

</details>

<AutomaticInstallQuickTest/>

## Manual install
Expand Down

0 comments on commit 2823b48

Please sign in to comment.