Skip to content

Commit bd994f8

Browse files
committed
added deploy instructions to the README
1 parent 61c3f3f commit bd994f8

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
For full documentation visit [mkdocs.org](http://mkdocs.org).
44

5+
## Installation
6+
7+
* Follow installation steps at [mkdocs.org](http://mkdocs.org).
8+
59
## Commands
610

711
* `mkdocs new [dir-name]` - Create a new project.
@@ -15,3 +19,11 @@ For full documentation visit [mkdocs.org](http://mkdocs.org).
1519
docs/
1620
index.md # The documentation homepage.
1721
... # Other markdown pages, images and other files.
22+
23+
## Deploying the site
24+
25+
* Ensure mkdocs is installed. See above.
26+
* Checkout the latest *dev* branch.
27+
* From the commandline, run `make deploy` - This will build the *dev* branch in the *master* branch.
28+
* Push changes to this repository.
29+
* Changes should be seen on [patternbuilder.github.io](http://patternbuilder.github.io).

0 commit comments

Comments
 (0)