2023-11-14 00:44:26 +03:00
|
|
|
# ⚠️ WARNING. IN DEVELOPMENT
|
2023-04-30 16:22:50 +03:00
|
|
|
|
2023-04-30 17:39:03 +03:00
|
|
|
![engine_icon](test/icons/apple-touch-icon.png)
|
2023-04-30 15:30:09 +03:00
|
|
|
|
2023-04-30 15:58:00 +03:00
|
|
|
# Documentation
|
|
|
|
|
2023-11-14 00:44:26 +03:00
|
|
|
- 🇷🇺 [Russian](README.ru.md)
|
2023-04-30 15:58:00 +03:00
|
|
|
|
2023-04-30 15:55:44 +03:00
|
|
|
# Build `ENGINE`
|
2023-04-30 15:26:00 +03:00
|
|
|
|
|
|
|
```sh
|
|
|
|
# install rollup
|
|
|
|
npm install --global rollup
|
|
|
|
|
|
|
|
# compile engine
|
|
|
|
cd src/js/
|
|
|
|
rollup main.js --file engine.js --format es
|
|
|
|
```
|
2023-04-30 15:55:44 +03:00
|
|
|
|
2023-04-30 16:22:50 +03:00
|
|
|
# Use it
|
|
|
|
|
|
|
|
...
|
|
|
|
|
2023-04-30 15:55:44 +03:00
|
|
|
# Contribute
|
|
|
|
|
2023-04-30 16:22:50 +03:00
|
|
|
## Branch info
|
|
|
|
|
|
|
|
- `master` — current `dev` branch.
|
|
|
|
- `release` — latest **stable** version branch.
|
|
|
|
|
2023-04-30 15:55:44 +03:00
|
|
|
## Git hooks
|
|
|
|
|
|
|
|
### pre-commit
|
|
|
|
|
|
|
|
**Requiments:**
|
|
|
|
|
|
|
|
1. NPM module `prettier`.
|
|
|
|
2. [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker)
|
|
|
|
(_Go application_).
|