Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Build] added postinstall script to "babylonjs" #12616

Merged
merged 1 commit into from
Jun 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/public/umd/babylonjs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"build:dev": "webpack --env development",
"build:prod": "webpack --env production",
"build:declaration": "build-tools -c pud --config ./config.json",
"clean": "rimraf dist && rimraf babylon*.*"
"clean": "rimraf dist && rimraf babylon*.*",
"postinstall": "node ./scripts/postinstall.js"
},
"devDependencies": {
"@dev/build-tools": "1.0.0",
Expand Down
22 changes: 6 additions & 16 deletions packages/public/umd/babylonjs/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Babylon.js

* We recommend using the [Core ES6-supported version](https://www.npmjs.com/package/@babylonjs/core);

Getting started? Play directly with the Babylon.js API using our [playground](https://playground.babylonjs.com/). It also contains a lot of samples to learn how to use it.

[![npm version](https://badge.fury.io/js/babylonjs.svg)](https://badge.fury.io/js/babylonjs)
Expand All @@ -16,15 +18,10 @@ Getting started? Play directly with the Babylon.js API using our [playground](ht
- <https://cdn.babylonjs.com/babylon.js>
- <https://cdn.babylonjs.com/babylon.max.js>

Additional references can be found on <https://cdn.babylonjs.com/xxx> where `xxx` is the folder structure you can find in the /dist folder like <https://cdn.babylonjs.com/gui/babylon.gui.min.js>

For the preview release, use the following URLs:

- <https://preview.babylonjs.com/babylon.js>
- <https://preview.babylonjs.com/babylon.max.js>

Additional references can be found on <https://preview.babylonjs.com/xxx> where xxx is the folder structure you can find in the /dist/preview release folder like <https://preview.babylonjs.com/gui/babylon.gui.min.js>

## npm

BabylonJS and its modules are published on npm with full typing support. To install, use:
Expand Down Expand Up @@ -60,7 +57,7 @@ To add a module, install the respective package. A list of extra packages and th

## Usage

See [Getting Started](https://doc.babylonjs.com/#getting-started):
See [Getting Started](https://doc.babylonjs.com/start):

```javascript
// Get the canvas DOM element
Expand Down Expand Up @@ -100,17 +97,13 @@ window.addEventListener('resize', function(){
});
```

## Preview release

Preview version of **4.1** can be found [here](https://github.com/BabylonJS/Babylon.js/tree/master/dist/preview%20release).
If you want to contribute, please read our [contribution guidelines](https://github.com/BabylonJS/Babylon.js/blob/master/contributing.md) first.

## Documentation

- [Documentation](https://doc.babylonjs.com)
- [Examples](https://doc.babylonjs.com/examples)
- [Examples](https://playground.babylonjs.com)

## Contributing

Please see the [Contributing Guidelines](./contributing.md).

## Useful links
Expand All @@ -127,8 +120,5 @@ Please see the [Contributing Guidelines](./contributing.md).

## Features

To get a complete list of supported features, please visit our [website](https://www.babylonjs.com/#specifications).

## Build
To get a complete list of supported features, please visit [Babylon.js website](https://www.babylonjs.com/).

Babylon.js is automatically built using [Gulp](https://gulpjs.com/). Further instructions can be found in [the documentation](https://doc.babylonjs.com/how_to/how_to_start#the-build) or in the readme at [/Tools/Gulp](https://github.com/BabylonJS/Babylon.js/tree/master/Tools/Gulp).
2 changes: 2 additions & 0 deletions packages/public/umd/babylonjs/scripts/postinstall.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
console.log("The Babylon.js team recommends using the es6-supported package - https://www.npmjs.com/package/@babylonjs/core");
console.log("Read more here - https://doc.babylonjs.com/divingDeeper/developWithBjs/treeShaking");