Skip to content

Commit

Permalink
Bump stable Chunky version to 2.4.5.
Browse files Browse the repository at this point in the history
  • Loading branch information
leMaik committed Oct 23, 2023
1 parent b471a6a commit 9d388e6
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Click on the pencil icon at the top right of any docs page to make small changes

1. Change the working directory to `./ChunkyDocs`.

2. Serve the site for development by using either the command, `CHUNKY_VERSION=20404 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation.
2. Serve the site for development by using either the command, `CHUNKY_VERSION=20405 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation.

Alternatively, on Windows, you can run either "serve_stable.bat" or "serve_snapshot.bat", depending on the version of Chunky for which you want to build documentation.

Expand Down
2 changes: 1 addition & 1 deletion ChunkyDocs/docs/getting_started/installing_chunky.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To install Chunky, download the Chunky Launcher (Universal JAR).[^1] This requir

| | CPU | Available RAM | Available Storage |
| --------------------------------- | ------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Minimum requirements**[^2] | CPU supported by Java & OpenJFX | 512 MB | 270 MB for core files: <ul><li><strong>Java 17:</strong> 135 MB</li><li><strong>OpenJFX:</strong> 110 MB</li><li><strong>Chunky 2.4.4:</strong> 25 MB</li></ul> |
| **Minimum requirements**[^2] | CPU supported by Java & OpenJFX | 512 MB | 270 MB for core files: <ul><li><strong>Java 17:</strong> 135 MB</li><li><strong>OpenJFX:</strong> 110 MB</li><li><strong>Chunky 2.4.5:</strong> 25 MB</li></ul> |
| **Recommended requirements** | 64-bit CPU | 8+ GB | 270 MB for core files + <ul><li><strong>Multiple Chunky versions:</strong> 50+ MB</li><li><strong>Multiple Chunky scenes:</strong> 1+ GB</li></ul> |

## Downloads
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ This site uses <a href="https://www.mkdocs.org/" target="_blank">mkdocs</a>. Pyt

- Step 4: If running Windows, simply run "serve_stable.bat" or "serve_snapshot.bat", depending on the version of Chunky for which you want to serve documentation. Otherwise, change the working directory to "./ChunkyDocs".

- Step 5: Serve the site for development by using the either the command, `CHUNKY_VERSION=20404 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation.
- Step 5: Serve the site for development by using the either the command, `CHUNKY_VERSION=20405 python -m mkdocs serve`, or the command, `CHUNKY_VERSION=20500 python -m mkdocs serve`, depending on the version of Chunky for which you want to serve documentation.

- Step 6: Build a preview of the final site by using either the command, `CHUNKY_VERSION=20404 python -m mkdocs build`, or the command `CHUNKY_VERSION=20500 python -m mkdocs build`, depending on the version of Chunky for which you want to build documentation. On Windows, first run either the command, `set CHUNKY_VERSION=20404`, or the command, `set CHUNKY_VERSION=20500`, depending on the version of Chunky for which you want to build documentation. Then run the command, `python -m mkdocs serve`.
- Step 6: Build a preview of the final site by using either the command, `CHUNKY_VERSION=20405 python -m mkdocs build`, or the command `CHUNKY_VERSION=20500 python -m mkdocs build`, depending on the version of Chunky for which you want to build documentation. On Windows, first run either the command, `set CHUNKY_VERSION=20405`, or the command, `set CHUNKY_VERSION=20500`, depending on the version of Chunky for which you want to build documentation. Then run the command, `python -m mkdocs serve`.

### With Docker

Expand Down
2 changes: 1 addition & 1 deletion VERSIONING_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Chunky Manual builds documentation for separate versions of Chunky from the same source code to avoid duplication of content.

The target version can be specified using the `CHUNKY_VERSION` environment variable when building/serving the docs (defaults to `20500`). The version must be specified as a number equal to `major * 10000 + minor * 100 + patch` (2.4.4 is `20404` and 2.5.0 is `20500`), which allows comparing versions easily.
The target version can be specified using the `CHUNKY_VERSION` environment variable when building/serving the docs (defaults to `20500`). The version must be specified as a number equal to `major * 10000 + minor * 100 + patch` (2.4.5 is `20405` and 2.5.0 is `20500`), which allows comparing versions easily.

## Page Versioning

Expand Down
4 changes: 2 additions & 2 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ else
sed -i 's/..\/versions.json/\/docs\/versions.json/g' ../docs/snapshot/assets/javascripts/bundle*.min.js
fi

CHUNKY_VERSION=20404 python -m mkdocs build
CHUNKY_VERSION=20405 python -m mkdocs build
cp -r site/* ../docs/
# get the versions from /docs/versions.json instead of the hard-coded ../versions.json
if [[ "$OSTYPE" == "darwin"* ]]; then
Expand All @@ -21,4 +21,4 @@ else
sed -i 's/..\/versions.json/\/docs\/versions.json/g' ../docs/assets/javascripts/bundle*.min.js
fi

echo '[{ "version": "../docs", "title": "2.4.4", "aliases": ["stable"] }, { "version": "../docs/snapshot", "title": "2.5.0 (snapshot)", "aliases": ["snapshot"] }]' > ../docs/versions.json
echo '[{ "version": "../docs", "title": "2.4.5", "aliases": ["stable"] }, { "version": "../docs/snapshot", "title": "2.5.0 (snapshot)", "aliases": ["snapshot"] }]' > ../docs/versions.json
2 changes: 1 addition & 1 deletion serve_stable.bat
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CD /d %~dp0/ChunkyDocs

set CHUNKY_VERSION=20404
set CHUNKY_VERSION=20405

python -m mkdocs serve

Expand Down

0 comments on commit 9d388e6

Please sign in to comment.