docs(all demos): add "Get just this demo" — per-folder clone instructions#65
Merged
Conversation
… one-folder fetch Every demo here is a standalone Gradle project, but the READMEs only told readers to clone the whole devslab-examples repo. Add a short "Get just this demo" section to all 20 demos (README.md + README.ko.md, 40 files) showing two ways to grab a single demo folder: - git sparse checkout: clone --filter=blob:none --sparse, then `git sparse-checkout set <demo>` — keeps git history, downloads only that folder. - tarball (no git): curl the main tarball piped through `tar -xz --strip-components=2 devslab-examples-main/<demo>` — folder only, no .git. Placed right after Prerequisites (or before the Run heading for the few demos that have no Prerequisites section), so the flow reads get -> run. Each block is parameterized to its own folder name; verified all 40 files reference the correct demo directory.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What / 무엇
Adds a "Get just this demo" section to every demo's README (
README.md+README.ko.md, all 20 demos / 40 files), showing how to fetch a single demo folder instead of cloning the whole repo.모든 데모 README(
README.md+README.ko.md, 20개 데모 / 40파일)에 "이 데모만 받기" 섹션 추가 — 저장소 전체를 clone하지 않고 데모 한 폴더만 받는 방법.Why / 왜
Each demo is a standalone Gradle project (own
settings.gradle.kts+gradlew), but the READMEs only documented cloning the entiredevslab-examplesrepo. Readers who want one demo had no copy-paste path.각 데모는 독립 Gradle 프로젝트인데, README는 전체 repo clone만 안내했음. 데모 하나만 원하는 사용자를 위한 복붙 경로가 없었음.
How / 어떻게
Two methods per demo, parameterized to that demo's folder:
clone --filter=blob:none --sparsethengit sparse-checkout set <demo>(keeps history, downloads only that folder)curl … main.tar.gz | tar -xz --strip-components=2 devslab-examples-main/<demo>(folder only, no.git)Placed right after Prerequisites (or just before the Run heading for the few demos without a Prerequisites section), so the flow reads get → run.
Verification / 검증