This is an automated email from the ASF dual-hosted git repository.
zregvart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-website.git
commit 235b517fff703201347183cccc4e170754b2432e
Author: Aemie <aemi...@hotmail.co.uk>
AuthorDate: Mon May 25 17:22:04 2020 +0530
update README to include instructions to use format
---
README.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/README.md b/README.md
index ff23ebe..09a563c 100644
--- a/README.md
+++ b/README.md
@@ -135,8 +135,11 @@ the theme bundle exists in
[antora-ui-camel/build/ui-bundle.zip](antora-ui-camel
To build the website go to the project root directory and run:
$ yarn install # needed only once, or if dependencies change
+ $ yarn format # to format the code
$ yarn build # to perform the build
+In case `yarn build` raises error, run `yarn format` to format the code and
re-run `yarn build` to build your bundle successfully.
+
In case `yarn build` throws the error: **JavaScript heap out of memory**, the
issue can be resolved by increasing the memory used by node.js by setting
`NODE_OPTIONS` environment variable to include `--max_old_space_size`, for
example to increase the old space to 4GB do:
```shell
