README.md
1# Cookbook Convertor
2
3Cookbook 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.
4
5## Prerequisits
6
7NodeJS 18 or later.
8
9## Building
10
11Run the following command to build the cookbook convertor project:
12
13```bash
14npm install
15```
16
17or:
18
19```bash
20npm run build
21```
22
23## Running
24
25Run the following command from the same directory:
26
27```bash
28node build/cookbook_convertor.js [rst_file]
29```
30