From 82a2e42cbb1fd8931cf29bd010a41d6488cf76aa Mon Sep 17 00:00:00 2001 From: Artem Kovalov Date: Fri, 28 Aug 2026 23:45:59 +0200 Subject: [PATCH] docs: add local setup instructions to README Add a Node.js quick-start alongside the existing Docker section, with an upfront guide on when to use each. Signed-off-by: Artem Kovalov --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c7a04a8..c40f8c2 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,25 @@ This is the official CobaltCore documentation. ## Requirements and Setup -### Docker Compose +Use **Local** if you have Node.js installed — it's faster and simpler. +Use **Docker** if you'd rather not install Node.js locally. - $ docker compose up +### Local -Run the above command to bring up an auto-refreshable development version of -the documentation. The documentation is accessible via -[http://localhost:5173/](). +Requires [Node.js](https://nodejs.org/) 18+. + +```sh +npm install +npm run docs:dev +``` + +### Docker + +```sh +docker compose up +``` + +In both cases the documentation is accessible at [http://localhost:5173/](http://localhost:5173/). ## Support, Feedback, Contributing