Skip to content

Commit a51ca21

Browse files
committed
update README.md accordingly
update README.md to reflect the change that `plate` is now a single executable.
1 parent 6b38782 commit a51ca21

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ $ cabal install
1212

1313
```sh
1414
$ cd example-website
15-
$ plate-compile
16-
$ plate
15+
$ plate compile
16+
$ plate run
1717
```
1818

1919
## Project goals
@@ -30,8 +30,8 @@ $ plate
3030
1. Put [CommonMark](http://commonmark.org/) documents under `data/`.
3131
1. Put templates under `tpl/`.
3232
1. Put static files under `static/`.
33-
1. Run `plate-compile` to create cache by converting CommonMark to HTML and applying templates.
34-
1. Run `plate` to start the HTTP server.
33+
1. Run `plate compile` to create cache by converting CommonMark to HTML and applying templates.
34+
1. Run `plate run` to start the HTTP server.
3535

3636
Use the `example-website/` directory as a reference.
3737

@@ -106,16 +106,17 @@ Files in the `static/` directory will be served directly.
106106

107107
… is done with two steps:
108108

109-
- `plate-compile`
110-
- `plate`
109+
- `plate compile`
110+
- `plate run`
111111

112-
`plate-compile` reads the source documents, converts CommonMark to HTML, applies the templating to create the cache, and put them under the `output/` directory. `plate` serves the contents of the `output/` and `static/`.
112+
`plate compile` reads the source documents, converts CommonMark to HTML, applies the templating to create the cache, and put them under the `output/` directory. `plate run` serves the contents of the `output/` and `static/`.
113113

114-
When running `plate` without the `-d` or `--debug` option, the [file descriptor cache duration](http://www.yesodweb.com/blog/2012/09/caching-fd) will be set to 60 seconds. Caching file descriptors significantly improves the performance, but it may cause misbehavior if you rapidly change site contents and do the refresh from the browser. Make sure you set `-d` during development.
114+
When running `plate run` without the `-d` or `--debug` option, the [file descriptor cache duration](http://www.yesodweb.com/blog/2012/09/caching-fd) will be set to 60 seconds. Caching file descriptors significantly improves the performance, but it may cause misbehavior if you rapidly change site contents and do the refresh from the browser. Make sure you set `-d` during development.
115115

116-
`plate` opens the port 3000 by default. You may override this with `-s` or `--socket` option. Example:
116+
`plate run` opens the port 3000 by default. You may override this with `-s` or `--socket` option. Example:
117117

118118
```sh
119-
plate -s 8080
119+
plate run
120+
plate run -s 8080
120121
sudo -u www-data plate -s /tmp/haskell-kr.socket
121122
```

0 commit comments

Comments
 (0)