Skip to content

Commit c6111da

Browse files
committed
Update read me to reflect change in the work flow
1 parent dfdd2cb commit c6111da

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,27 @@ This repository contains TmLanguage files that are consumed by TypeScript editor
55

66
# Contributing
77

8-
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 the [AAAPackageDev](https://github.com/SublimeText/AAAPackageDev) plugin.
8+
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.
9+
10+
## Build
11+
12+
Update the XML files from within the ```build``` folder
13+
14+
``` sh
15+
cd build
16+
npm install # Installs dependencies required for building
17+
npm start # Compiles & builds the XML files
18+
```
919

1020
## Tests
1121

12-
Test are run from within the ```tests``` folder
22+
Test are run from within the ```tests``` folder and depend on build to make sure XML files are upto date
1323

1424
``` sh
15-
cd tests
25+
cd build
26+
npm install # Installs dependencies required for building
27+
28+
cd ../tests
1629
npm install # Installs dependencies required for testing
1730
npm test # Compiles & runs tests
1831
```

0 commit comments

Comments
 (0)