Skip to content

Commit

Permalink
chore: update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
apostolos committed May 26, 2024
1 parent 138233c commit ac01b8f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
10 changes: 5 additions & 5 deletions DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ac01b8f

Please sign in to comment.