Skip to content

Commit 46b22bd

Browse files
author
Jani Giannoudis
committed
updated README.md
1 parent 9b5b436 commit 46b22bd

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
<h1>Payroll Engine Client Scripting</h1>
22

3-
The scripting library which determines the commonality between the backend and the clients:
3+
The scripting library that defines the commonality between the backend and the clients:
44
- Scripting functions
55
- Scripting runtime
66
- Script parsers
77
- System scripts
88

9+
## HTML documentantion
10+
The client scripting library contains static HTML documentation for scripting developers. This is created using [docx](https://github.com/dotnet/docfx) [MIT]. The following commands are available in the `docfx` folder:
11+
- `Static.Build` - builds the static HTML content (output is the `_site` subdirectory)
12+
- `Static.Static` - opens the static help (`_site\index.html`)
13+
- `Server.Start` - start the static help on http://localhost:5865/ (dark mode support)
14+
915
## Build
1016
Supported runtime environment variables:
11-
- *PayrollEnginePackageDir* - the NuGet package target direcotry (optional)
17+
- *PayrollEnginePackageDir* - the NuGet package destination directory (optional)

0 commit comments

Comments
 (0)