Skip to content

add a quick how to start section to README #3575

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
merged 1 commit into from
Sep 16, 2025
Merged

add a quick how to start section to README #3575

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,22 @@ providers as well as enterprise IT departments offering APIs within their compan

**NB:** In May 2023, the kcp project was restructured and components related to workload scheduling (e.g. the syncer) and the transparent multi cluster (tmc) code were removed due to lack of interest/maintainers. Please refer to the [`main-pre-tmc-removal` branch](https://github.com/kcp-dev/kcp/tree/main-pre-tmc-removal) if you are interested in the related code.

## Getting Started

**For Users:** Follow our [Setup & Quick Start](https://docs.kcp.io/kcp/main/setup/quickstart/) guide to download and run kcp.

**For Developers:** To build and run kcp from source:
```bash
# Build and run from source
go run ./cmd/kcp start

# In another terminal:
export KUBECONFIG=.kcp/admin.kubeconfig && kubectl get workspaces
```

**Learn More:**
- [Concepts & Tenancy Guide](https://docs.kcp.io/kcp/main/concepts/quickstart-tenancy-and-apis/) - Learn about workspaces, workspace types, and APIs

## Documentation

Please visit [docs.kcp.io/kcp](https://docs.kcp.io/kcp/latest) for our documentation.
Expand Down