From ac01b8f524d3ac266ee1e0c36e8b497f5fa3e7c3 Mon Sep 17 00:00:00 2001 From: Apostolos Tsakpinis Date: Sun, 26 May 2024 05:05:45 +0300 Subject: [PATCH] chore: update READMEs --- DEPLOYMENT.md | 10 +++++----- README.md | 17 +++++++++-------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index 860c384c..5f4294aa 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -36,18 +36,18 @@ docker run -it --rm docker.pkg.github.com/lwjgl/lwjgl3-www/lwjgl-website sh ```shell git pull -npm i -npm run release +pnpm i +node --run release # to launch use: -npm run test-production +node --run test-production ``` ## Build Docker image locally ```shell git pull -npm i -npm run release +pnpm i +node --run release docker build --rm -t lwjgl/website:latest . # To test the production docker image: docker-compose up diff --git a/README.md b/README.md index e3e6aaf2..551a711c 100644 --- a/README.md +++ b/README.md @@ -32,22 +32,23 @@ Build status icons are loaded directly from [travis-ci.org](https://travis-ci.or ## Prerequisites -- [Node.js v19+](https://nodejs.org/) -- [NPM v9+](https://npmjs.com/) +- [Node.js v22+](https://nodejs.org/) +- [PNPM](https://pnpm.io/) ## Development Install all required npm packages and build styles: ```shell -npm i -npm run build:styles +#corepack enable +pnpm i +node --run build:styles ``` Start the server in dev mode: ```shell -npm -s start +node --run start ``` ### CLI flags @@ -82,14 +83,14 @@ To deploy LWJGL in production please read the separate guide: [DEPLOYMENT.md](./ ```shell git pull -npm i -npm run release +pnpm i +node --run release ``` You can run the production build locally: ```shell -npm run dev:test-production +node --run dev:test-production ``` ### Debugging production output