Skip to content

Commit 091f64a

Browse files
update README for clarity on CI workflows and local installation instructions
1 parent e8181fa commit 091f64a

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Struct Forge
2+
23
[![Build dev](https://github.com/aecoder-br/structforge/actions/workflows/ci-dev.yml/badge.svg)](https://github.com/aecoder-br/structforge/actions/workflows/ci-dev.yml)
34
[![Build main](https://github.com/aecoder-br/structforge/actions/workflows/ci-main.yml/badge.svg)](https://github.com/aecoder-br/structforge/actions/workflows/ci-main.yml)
45
[![License](https://img.shields.io/github/license/aecoder-br/structforge.svg)](LICENSE)
56
[![Stars](https://img.shields.io/github/stars/aecoder-br/structforge.svg?style=social)](https://github.com/aecoder-br/structforge)
67
[![Node >=18](https://img.shields.io/badge/node-%3E%3D18-339933.svg)](https://nodejs.org/)
78
[![npm version](https://img.shields.io/npm/v/structforge.svg)](https://www.npmjs.com/package/structforge)
89

9-
1010
A CLI that turns text trees into real folder and file structures.
1111
It supports:
1212

@@ -19,6 +19,15 @@ No runtime dependencies, TypeScript only for build.
1919

2020
## Local install
2121

22+
```bash
23+
# (optional) pin pnpm via Corepack and use the frozen lockfile (same as CI)
24+
corepack enable
25+
corepack prepare pnpm@9 --activate
26+
pnpm i --frozen-lockfile
27+
pnpm build
28+
pnpm test
29+
```
30+
2231
```bash
2332
pnpm i
2433
pnpm build
@@ -146,7 +155,7 @@ Use clear, present-tense messages. Conventional Commits is recommended, for exam
146155

147156
### CI
148157

149-
CI runs on pushes and PRs to `dev` and `main`. The status badges above use `ci.yml`.
158+
CI runs on pushes and PRs to `dev` and `main`. The status badges above use `ci-dev.yml` and `ci-main.yml`.
150159

151160
## Release
152161

0 commit comments

Comments
 (0)