Skip to content

Commit 5a742aa

Browse files
committed
Updated the "Getting Started", "Internals" and "Migration Guide" for the 3.0 release
JerryScript-DCO-1.0-Signed-off-by: Laszlo Lango [email protected]
1 parent d2d30df commit 5a742aa

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

docs/00.GETTING-STARTED.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ Currently, only Ubuntu 18.04+ is officially supported as primary development env
55
There are several dependencies, that should be installed manually. The following list is the absolute minimum for building:
66

77
- `gcc` or any C99-compliant compiler (native or cross, e.g., arm-none-eabi)
8-
- `cmake` >= `2.8.12.2`
8+
- `cmake` >= `3.10`
99

1010
Several scripts and tools help the building and development process, thus it is recommended to have the following installed as well:
1111

1212
- `bash` >= `4.3.11`
13-
- `cppcheck` >= `1.61`
14-
- `clang-format-10` >= `10.0.0`
15-
- `python` >= `2.7.6`
13+
- `cppcheck` >= `2.7`
14+
- `clang-format-15`
15+
- `python` >= `3.10`
1616

1717
```bash
18-
sudo apt-get install gcc gcc-arm-none-eabi cmake cppcheck clang-format-10 python
18+
sudo apt-get install gcc gcc-arm-none-eabi cmake cppcheck clang-format-15 python
1919
```
2020

2121
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
5757
python tools/build.py --profile=es.next|minimal
5858
```
5959

60-
See also the related [README.md](https://github.com/jerryscript-project/jerryscript/blob/master/jerry-core/profiles/README.md).
60+
See also the related [README.md](../jerry-core/profiles/README.md).
6161

6262
**Use (compiler-default, external) libc**
6363

docs/04.INTERNALS.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# OUTDATED since 2.0
2+
3+
This documentation become partially outdated since v2.0.
4+
15
# High-Level Design
26
![High-Level Design](img/engines_high_level_design.png)
37

docs/16.MIGRATION-GUIDE.md

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

0 commit comments

Comments
 (0)