Skip to content

Commit c4ec6ad

Browse files
authored
Merge pull request #3575 from olamilekan000/add-quick-how-to-run-session
add a quick how to start section to README
2 parents 2b42b96 + 627385a commit c4ec6ad

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,22 @@ providers as well as enterprise IT departments offering APIs within their compan
2020

2121
**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.
2222

23+
## Getting Started
24+
25+
**For Users:** Follow our [Setup & Quick Start](https://docs.kcp.io/kcp/main/setup/quickstart/) guide to download and run kcp.
26+
27+
**For Developers:** To build and run kcp from source:
28+
```bash
29+
# Build and run from source
30+
go run ./cmd/kcp start
31+
32+
# In another terminal:
33+
export KUBECONFIG=.kcp/admin.kubeconfig && kubectl get workspaces
34+
```
35+
36+
**Learn More:**
37+
- [Concepts & Tenancy Guide](https://docs.kcp.io/kcp/main/concepts/quickstart-tenancy-and-apis/) - Learn about workspaces, workspace types, and APIs
38+
2339
## Documentation
2440

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

0 commit comments

Comments
 (0)