From a34b7031d5d08bea033a0521fb339a5f232ec5a2 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Thu, 14 Nov 2024 11:56:49 -0800 Subject: [PATCH 1/2] Clarify site build prereqs --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1d180ec4..5d37fbe3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,16 @@ $ npm install ## Local development +**Prerequisite**: Currently, the site won't build unless you first check out the JavaScript library in a sibling directory and build the API docs there. In the parent directory of `opensource.contentauth.org`, enter these commands: + +``` +$ git clone git@github.com:contentauth/c2pa-js.git +$ cd opensource.contentauth.org +$ npm run docs:generate-api-docs +``` + +Then you can build and run the doc site with this command: + ``` $ npm start ``` From 51fa1ba59025b538a3dced43c730991c7a56d1d1 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Thu, 14 Nov 2024 12:07:18 -0800 Subject: [PATCH 2/2] wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d37fbe3..8a083f5a 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ $ npm install ## Local development -**Prerequisite**: Currently, the site won't build unless you first check out the JavaScript library in a sibling directory and build the API docs there. In the parent directory of `opensource.contentauth.org`, enter these commands: +**Prerequisite**: To build the site locally, you must first check out the JavaScript library in a sibling directory and build the API docs there. In the parent directory of `opensource.contentauth.org`, enter these commands: ``` $ git clone git@github.com:contentauth/c2pa-js.git