mirror of
https://github.com/Kaelio/ktx.git
synced 2026-07-01 08:59:39 +02:00
docs: refresh setup and install guidance
This commit is contained in:
parent
94fc580a3d
commit
1b552a38c2
4 changed files with 128 additions and 319 deletions
|
|
@ -7,6 +7,11 @@ KTX is an open-source project and welcomes contributions — bug fixes, new conn
|
|||
|
||||
## Development setup
|
||||
|
||||
This page is for contributors working on the KTX repository. To install KTX for
|
||||
an analytics project, use the published
|
||||
[`@kaelio/ktx`](https://www.npmjs.com/package/@kaelio/ktx) package in the
|
||||
[Quickstart](/docs/getting-started/quickstart).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Node.js 22+** and **pnpm** — for the TypeScript workspace
|
||||
|
|
@ -44,7 +49,9 @@ pnpm run setup:dev
|
|||
pnpm run link:dev
|
||||
```
|
||||
|
||||
This makes the `ktx` command available globally, pointing at your local build.
|
||||
This makes the `ktx-dev` command available globally, pointing at your local
|
||||
build. Use this development binary when you need to test unpublished repository
|
||||
changes.
|
||||
|
||||
## Repository structure
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue