Skip to content

Commit 480053f

Browse files
Include FE build instructions
1 parent 62aa72b commit 480053f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

scala3doc/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ respectively.
3838
It's not strictly necessary to go through an HTTP server, but because of CORS
3939
the documentation won't work completely if you don't.
4040

41+
## Building frontend
42+
43+
Make sure you have installed `node`
44+
45+
- Go to `resources` folder and run: `npm i`
46+
- Start development server and weback in watch mode: `npm run dev`
47+
- Finally, run `sbt scala3/generateTestcasesDocumentation` when you want to preview newest changes
48+
4149
## CLI Documentation
4250

4351
CLI command for running our tool is in form: `sbt main -n <name> -o <output> -t <tasty-files> -cp <classpath> -s { <sources> } -d <documentation> ` where:

0 commit comments

Comments
 (0)