Skip to content

Commit daa0326

Browse files
committed
Chore: Refactor documentation from README to DEVELOP
1 parent 866cac0 commit daa0326

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

DEVELOP.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ with the [Fivetran SDK Development Guide].
99
```shell
1010
git clone https://github.com/crate/cratedb-fivetran-destination.git
1111
cd cratedb-fivetran-destination
12-
uv venv --seed
12+
uv venv --python 3.13 --seed .venv
1313
source .venv/bin/activate
1414
uv pip install --upgrade --editable='.[develop,test]'
1515
```
@@ -68,8 +68,16 @@ docker run --rm -it \
6868
--tester-type destination --port 50052
6969
```
7070

71-
## OCI builds
71+
## Building
7272

73+
### Standalone builds
74+
Build a standalone executable using PyInstaller.
75+
```shell
76+
uv pip install --upgrade --editable='.[release]'
77+
uv run poe build-app
78+
```
79+
80+
### OCI builds
7381
Build OCI images on your workstation.
7482
```shell
7583
export BUILDKIT_PROGRESS=plain

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,8 @@ i.e. pre-alpha.
5151
For installation per [PyPI package][PyPI], [OCI image], [standalone executable],
5252
and usage information, please visit the [handbook] document.
5353

54-
## Build
55-
Build a standalone executable using PyInstaller:
56-
```shell
57-
git clone https://github.com/crate/cratedb-fivetran-destination
58-
cd cratedb-fivetran-destination
59-
uv pip install --upgrade --editable='.[release]'
60-
uv run poe build-app
61-
```
54+
For building the application, or hacking on it, please refer to the
55+
[development sandbox] documentation.
6256

6357
## Project Information
6458

@@ -80,6 +74,7 @@ The project uses the Apache license, like CrateDB itself.
8074
[CrateDB]: https://cratedb.com/database
8175
[CrateDB Cloud]: https://cratedb.com/database/cloud
8276
[CrateDB destination adapter for Fivetran]: https://cratedb.com/docs/guide/integrate/fivetran/
77+
[development sandbox]: https://github.com/crate/cratedb-fivetran-destination/blob/main/DEVELOP.md
8378
[Fivetran]: https://www.fivetran.com/
8479
[Fivetran SDK Development Guide]: https://github.com/fivetran/fivetran_sdk/blob/main/development-guide.md
8580
[handbook]: https://github.com/crate/cratedb-fivetran-destination/blob/main/docs/handbook.md

0 commit comments

Comments
 (0)