README.md
1# Cookbook Convertor
2Cookbook convertor is a tool that generates rule descriptions for TS Linter from Cookbook receipts. Convertor accepts RST file that contains the sources for Cookbook receipts.
3
4## Prerequisits
5
6NodeJS 18 or later.
7
8## Building
9
10Run the following command to build the cookbook convertor project:
11
12```bash
13npm install
14```
15
16or:
17
18```bash
19npm run build
20```
21
22## Running
23Run the following command from the same directory:
24```bash
25node build/cookbook_convertor.js [rst_file]
26```
27