Skip to content

Commit b18a36f

Browse files
tudor-svifox
authored andcommitted
docs readme.md explicit steps
1 parent 4c41e75 commit b18a36f

1 file changed

Lines changed: 20 additions & 2 deletions

File tree

docs/readme.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
11
# Twill docs
22

3-
## Install
3+
## Prerequisites
44

5-
To compile and serve the docs site at `http://localhost:8000/` run at the ROOT of `/twill`
5+
You must already have installed node & php dependencies:
6+
```
7+
npm i
8+
composer install
9+
```
10+
11+
## View in browser
12+
13+
To compile and serve the docs site, run:
14+
```
15+
npm run docs
16+
```
17+
18+
then go to `http://localhost:8000/docs`
19+
20+
21+
## Other commands
22+
23+
To serve docs:
624
```
725
./vendor/bin/testbench twill:staticdocs:serve
826
```

0 commit comments

Comments
 (0)