Skip to content

Update Readme doc#35

Merged
dimakis merged 1 commit intodimakis:mainfrom
CathalOConnorRH:Update_readme
Feb 22, 2026
Merged

Update Readme doc#35
dimakis merged 1 commit intodimakis:mainfrom
CathalOConnorRH:Update_readme

Conversation

@CathalOConnorRH
Copy link
Contributor

@CathalOConnorRH CathalOConnorRH commented Feb 16, 2026

Summary

  • Update Readme.md to include the correct git url
  • Add the requirement for npm at UI stage of install

Motivation

instructions included the incorrect url and project folder.
The instruction also missed out the detail of having NPM installed as a prerequisite for the UI stage of the install

Type of Change

  • feat — New feature
  • fix — Bug fix
  • refactor — Code restructuring (no feature or fix)
  • perf — Performance improvement
  • test — Adding or updating tests
  • docs — Documentation only
  • build / ci — Build system or CI changes
  • chore — Other (no src or test change)
  • Breaking change — Requires a major version bump

Changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • E2E tests added/updated
  • Manual testing — describe below

Security Considerations

  • No security implications
  • Security review needed — explain:

Checklist

  • My code follows the project's style (ruff, mypy pass)
  • I've written tests that prove my fix/feature works
  • I've updated documentation if needed
  • I've added conventional commit messages
  • Coverage has not decreased
  • CI passed locally (make ci-local)
  • Branch commits squashed into a single conventional commit
  • Ready for rebase-merge

Update Readme.md to include the correct git url and the requirement for npm at UI stage of install
@dimakis dimakis merged commit 07a8270 into dimakis:main Feb 22, 2026
8 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants