Skip to content

Commit

Permalink
added some notes about building to the root readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bennage committed Feb 20, 2018
1 parent bcb91b8 commit 217e958
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@ Microsoft patterns & practices

http://aka.ms/architecture

## Understanding the local build process

Some of the markdown files are generated from data stored in json files.
This is primarily to avoid human error for pages that still require some HTML.
The process that converts the json to markdown uses a utility script located in the `build` folder.
To run the build script, navigate to the root folder of this repository.

```bash
npm install
node .\build\build.js
```

## Legal Notices
Microsoft and any contributors grant you a license to the Microsoft documentation and other content
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),
Expand Down

0 comments on commit 217e958

Please sign in to comment.