Skip to content

Commit 1e37a4d

Browse files
committed
docs: remove private repo notice from README and add local setup instructions
1 parent 9816097 commit 1e37a4d

1 file changed

Lines changed: 35 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,6 @@ Bro-code is a toy programming language written in TypeScript with its own custom
88

99
- **Website / Docs**: [brocode.js.org](https://brocode.js.org/)
1010
- **Interactive Web Playground**: [brocode.js.org/#playground](https://brocode.js.org/#playground)
11-
12-
## Why this README exists
13-
14-
This README is designed to be publicly visible while the source repository remains private.
15-
It documents the language, grammar, architecture, and technical approach.
16-
1711
## Quick start (language)
1812

1913
Minimal program:
@@ -236,7 +230,41 @@ flowchart LR
236230
- Explicit runtime exceptions for invalid operations.
237231
- Control flow support for conditional branches and loops.
238232

239-
## Public links
233+
## Local development
234+
235+
### Prerequisites
236+
237+
- Node.js >= 18
238+
- npm >= 7
239+
240+
### Installation
241+
242+
```bash
243+
git clone https://github.com/ClaudeMaxUser/bro-code.git
244+
cd bro-code
245+
npm install
246+
```
247+
248+
### Scripts
249+
250+
```bash
251+
# Start local docs & playground development server
252+
npm run dev
253+
254+
# Run all test suites across packages
255+
npm run test
256+
257+
# Lint all workspaces
258+
npm run lint
259+
260+
# Build all packages & export docs site
261+
npm run build
262+
263+
# Format code with Prettier
264+
npm run format
265+
```
266+
267+
## Links
240268

241269
- **Website & Documentation**: [https://brocode.js.org/](https://brocode.js.org/)
242270
- **Interactive Playground**: [https://brocode.js.org/#playground](https://brocode.js.org/#playground)

0 commit comments

Comments
 (0)