Skip to content

Commit 217e958

Browse files
committed
added some notes about building to the root readme
1 parent bcb91b8 commit 217e958

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@ Microsoft patterns & practices
33

44
http://aka.ms/architecture
55

6+
## Understanding the local build process
7+
8+
Some of the markdown files are generated from data stored in json files.
9+
This is primarily to avoid human error for pages that still require some HTML.
10+
The process that converts the json to markdown uses a utility script located in the `build` folder.
11+
To run the build script, navigate to the root folder of this repository.
12+
13+
```bash
14+
npm install
15+
node .\build\build.js
16+
```
17+
618
## Legal Notices
719
Microsoft and any contributors grant you a license to the Microsoft documentation and other content
820
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),

0 commit comments

Comments
 (0)