Skip to content

Documentation and lock file inconsistency: pnpm vs npm in install instructions #29

@maehr

Description

@maehr

Current Behavior

The repository provides a pnpm-lock.yaml file suggesting pnpm is used, but the README.md and README.template.md use npm (e.g., 'npm install'). This may be confusing for users and could lead to mixed package managers.

Reproduction / Steps To Reproduce

  1. Open the root directory and see pnpm-lock.yaml present.
  2. Read the install instructions in README.md and README.template.md for 'npm install'.
  3. Attempt to use both npm and pnpm, resulting in mixed or unexpected dependencies.

Anything else?

Recommended solution: Remove pnpm-lock.yaml and use npm for consistency, since the docs standardize on npm. Optionally, re-create a lockfile with 'npm install' after removing pnpm-lock.yaml.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions