This is an automated email from the ASF dual-hosted git repository.
joshtynjala pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-website.git
The following commit(s) were added to refs/heads/master by this push:
new ef274a03 README: expanded instructions
ef274a03 is described below
commit ef274a0387a007f10afaa93bc371f63eda417d6f
Author: Josh Tynjala <[email protected]>
AuthorDate: Mon Sep 12 12:04:05 2022 -0700
README: expanded instructions
---
readme.md | 24 ++++++++++++++++++++----
1 file changed, 20 insertions(+), 4 deletions(-)
diff --git a/readme.md b/readme.md
index 302da23c..77238a81 100644
--- a/readme.md
+++ b/readme.md
@@ -1,10 +1,12 @@
# royale-11ty
-Built with [Eleventy](https://11ty.dev/).
+Built with the [Eleventy](https://11ty.dev/) static site generator.
## Prerequisites
-Install dependencies.
+Install [Node.js](https://nodejs.org/), if you don't have it already.
+
+Then, use **npm** (which is included with Node.js) to install dependencies.
```sh
npm ci
@@ -12,14 +14,28 @@ npm ci
## Run Local Server
+For development, run the following command to start a local server.
+
```sh
npm start
```
-## Build
+Then, open a browser with the following URL: _http://localhost:8080_
+
+Changes to files will be detected automatically, and your browser will refresh
too.
+
+## Build Locally
+
+The build the website locally, run this command.
```sh
npm run build
```
-Build output will be in __site_ directory.
\ No newline at end of file
+Build output will be in __site_ directory.
+
+> Generally, building the website shouldn't be necessary because the CI server
builds and deploys automatically.
+
+## Deployment
+
+Deployment happens automatically. Commit changes to the master branch, and the
site will be built and deployed by the CI server.
\ No newline at end of file
