archive-gh-me/jerryscript
1
0
Fork 0
mirror of https://github.com/jerryscript-project/jerryscript.git synced 2025-12-15 16:29:21 +00:00
Code Issues Projects Releases Wiki Activity

Updated the "Getting Started" and "Migration Guide" for the 3.0 release (#5202)

Browse Source 
JerryScript-DCO-1.0-Signed-off-by: Laszlo Lango laszlo.lango@h-lab.eu
This commit is contained in:
László Langó 2024-12-18 11:28:38 +01:00 committed by GitHub
parent d2d30df420
commit 4cda596060
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/00.GETTING-STARTED.md
View File

@ -5,17 +5,17 @@ Currently, only Ubuntu 18.04+ is officially supported as primary development env
There are several dependencies, that should be installed manually. The following list is the absolute minimum for building:
- `gcc` or any C99-compliant compiler (native or cross, e.g., arm-none-eabi)
- `cmake` >= `2.8.12.2`
- `cmake` >= `3.10`
Several scripts and tools help the building and development process, thus it is recommended to have the following installed as well:
- `bash` >= `4.3.11`
- `cppcheck` >= `1.61`
- `clang-format-10` >= `10.0.0`
- `python` >= `2.7.6`
- `cppcheck` >= `2.7`
- `clang-format-15`
- `python` >= `3.10`
```bash
sudo apt-get install gcc gcc-arm-none-eabi cmake cppcheck clang-format-10 python
sudo apt-get install gcc gcc-arm-none-eabi cmake cppcheck clang-format-15 python
```
To make our scripts run correctly, several shell utilities should be available on the system:
@ -57,7 +57,7 @@ python tools/build.py --cmake-param=CMAKE_PARAM
python tools/build.py --profile=es.next|minimal
```
See also the related [README.md](https://github.com/jerryscript-project/jerryscript/blob/master/jerry-core/profiles/README.md).
See also the related [README.md](../jerry-core/profiles/README.md).
**Use (compiler-default, external) libc**

8
docs/16.MIGRATION-GUIDE.md
View File

@ -771,3 +771,11 @@ In this section the new API functions are listed.
- [`jerry_port_fatal`](05.PORT-API.md#jerry_port_fatal)
- [`jerry_port_sleep`](05.PORT-API.md#jerry_port_sleep)
- [`jerry_port_print_byte`](05.PORT-API.md#jerry_port_print_byte)
# Migrating from 2.x to 3.x
The most significant change in JerryScript 3.0 was the API rework. Most of the API functions had been
renamed in this version. There are notes for every such function in the [API Reference](02.API-REFERENCE.md)
to help you to migrate from an older version. For example:
*Renamed in version 3.0, it was previously known as `jerry_get_global_object` in earlier versions.*