Skip to content

Commit 1f010d7

Browse files
authored
Update README.md
1 parent 8b528dc commit 1f010d7

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,24 @@ Latest version of the grammar can be also found as a [VSCode extension](https://
99

1010
The XML files are generated from the YAML files, so contributors should hand-modify the YAML files, and XML files should only be generated by running build script.
1111

12+
## Install dependencies
13+
``` sh
14+
npm install
15+
```
16+
1217
## Build
1318

14-
Update the XML files from within the ```build``` folder
19+
Compile the yaml file into the tmLanguage and tmTheme files
1520

1621
``` sh
17-
cd build
18-
npm install # Installs dependencies required for building
19-
npm start # Compiles & builds the XML files
22+
npm run build:grammar
2023
```
2124

2225
## Tests
2326

24-
Test are run from within the ```tests``` folder and depend on build to make sure XML files are upto date
25-
2627
``` sh
27-
cd build
28-
npm install # Installs dependencies required for building
29-
30-
cd ../tests
31-
npm install # Installs dependencies required for testing
3228
npm test # Compiles & runs tests
3329

3430
npm run diff # Diffs the test baselines with generated one using tool set in environment variable DIFF
3531
npm run accept # Accepts the test baselines
36-
```
32+
```

0 commit comments

Comments
 (0)