Fix in-tree URL from readme

Signed-off-by: Mario Limonciello <superm1@kernel.org>
1 file changed
tree: 1e0be77798d96f10ac3c9ec71705b28e57f614ec
  1. .github/
  2. .vscode/
  3. docs/
  4. src/
  5. .gitignore
  6. .pre-commit-config.yaml
  7. LICENSE
  8. Makefile
  9. psr.py
  10. pyproject.toml
  11. README.md
README.md

Helpful tools for debugging AMD Zen systems

codecov PyPI

This repository hosts open tools that are useful for debugging issues on AMD systems.

Installation

Distro (Arch)

amd-debug-tools has been packaged for Arch Linux (and derivatives). You can install it using:

pacman -Sy amd-debug-tools

Using a python wheel (Generic)

It is suggested to install tools in a virtual environment either using pipx or python3 -m venv.

From PyPI

amd-debug-tools is distributed as a python wheel, which is a binary package format for Python. To install from PyPI, run the following command:

pipx install amd-debug-tools

From source

To build the package from source, you will need to the python3-build package natively installed by your distribution package manager. Then you can generate and install a wheel by running the following commands:

python3 -m build
pipx install dist/amd-debug-tools-*.whl

Ensuring path

If you have not used a pipx environment before, you may need to run the following command to set up the environment:

pipx ensurepath

This will add the pipx environment to your path.

Running in-tree

Documentation about running directly from a git checkout is available here.

Tools

Each tool has its own individual documentation page: