Skip to content

docs: Add git submodule install instructions #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kylebarron merged 2 commits into from
Jun 15, 2026
Merged

docs: Add git submodule install instructions #602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bcd8762
docs: document git submodule init step in DEVELOP.md
abarciauskas-bgse Jun 12, 2026
3362e0d
Modified setup instructions
abarciauskas-bgse Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions DEVELOP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@

This is a monorepo managed with pnpm workspaces.

## Package setup

Some packages (e.g. `morecantile`, `geozarr`) reference files from git submodules.
Initialize them before building.

```bash
# Initialize git submodules (required for the build)
git submodule update --init --recursive

# Install dependencies
pnpm install

Expand All @@ -11,7 +19,11 @@ pnpm build

# Watch mode for development
pnpm build:watch
```

## Package Testing

```bash
# Run tests in all packages
pnpm test

Expand Down
13 changes: 3 additions & 10 deletions examples/cog-basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,13 @@ The example displays 10m resolution RGB imagery of New Zealand from LINZ (Land I

## Setup

1. Install dependencies from the repository root:
```bash
pnpm install
```
1. Follow instructions for package setup in [DEVELOP.md](../../DEVELOP.md#package-setup).

2. Build the packages:
```bash
pnpm build
```
2. Run the development server:

3. Run the development server:
```bash
cd examples/cog-basic
pnpm dev
```

4. Open your browser to http://localhost:3000
3. Open your browser to http://localhost:3000
Loading