Skip to content

Commit a3c7edf

Browse files
committed
Add instructions for using the template repo.
1 parent c9af8cf commit a3c7edf

3 files changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,24 @@ This is analogous to the banking example in the paper: instead of deposits/withd
6363

6464
---
6565

66+
## Use This Repository as a Template
67+
68+
This repository is a **GitHub template**. You can create your own copy to work in (so commits and experiments stay in your own repo without forking the tutorial).
69+
70+
1. Open the template repository on GitHub (for example `lf-lang/lf-tutorial-handson-2026`).
71+
2. Click **Use this template**, then choose **Create a new repository** (or **Open in a codespace** if you prefer a cloud dev environment).
72+
73+
![Use this template: Create a new repository or Open in a codespace](assets/github-use-template.png)
74+
75+
3. On the **Create a new repository** page, pick the **Owner** and **Repository name**, add an optional **Description**, choose **visibility** (Public or Private), then click **Create repository**.
76+
By default only the default branch is copied; turn on **Include all branches** only if you need every branch from the template.
77+
78+
![Create a new repository from the template](assets/github-create-repository.png)
79+
80+
After creation, clone **your** new repository locally and follow [Running the Code](#running-the-code).
81+
82+
---
83+
6684
## Running the Code
6785

6886
Each `.lf` file in the `src/` directory can be compiled and run with:
98 KB
Loading

assets/github-use-template.png

22.2 KB
Loading

0 commit comments

Comments
 (0)